From 5cbd464e9cb8531edd8ae8ea88091b024075db6c Mon Sep 17 00:00:00 2001 From: Sahu97494 Date: Thu, 25 Sep 2025 17:26:03 -0700 Subject: [PATCH 1/4] added mintlify-migration MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Your Mintlify docs migration is now complete and available at staging site hosted by us here: https://e2b-preview.mintlify.app/ Resources * Migrated Repository: * Staging Domain: https://e2b-preview.mintlify.app/ What's Included: * All documentation content migrated to MDX format * Navigation structure preserved * Mintlify configuration (docs.json) set up * Basic styling and branding applied Next Steps To complete your documentation setup, please: 1. Connect Repository to Dashboard * Go to Settings > Git settings in your Mintlify dashboard * Connect the repository linked above 1. Set Up Redirects (if needed) * Add any necessary redirects for existing URLs * Our docs here: https://mintlify.com/docs/settings/broken-links#redirects-and-broken-links 1. Configure Custom Domain * Add your custom domain to go live * Our docs here: https://mintlify.com/docs/settings/custom-domain#custom-domain 1. Review and Provide Feedback * Timeline: 3 business days until Monday * Method: Please consolidate feedback in a single Slack thread or Google Doc and send to us over Slack * Delivery: We will review the feedback, outline what’s in scope and try our best to address that feedback within 3 business days Support * Migration Support: Available until 9/30 in this Slack channel * Ongoing Support: support@mintlify.com The Slack channel will be closed once outstanding migration issues are resolved. --- .../src/app/(docs)/mintlify-docs/README.md | 32 + .../src/app/(docs)/mintlify-docs/_mint.json | 130 + .../(docs)/mintlify-docs/api-key/index.mdx | 41 + .../mintlify-docs/broken_links_report.mdx | 2 + .../app/(docs)/mintlify-docs/byoc/index.mdx | 70 + .../(docs)/mintlify-docs/cli/auth/index.mdx | 12 + .../app/(docs)/mintlify-docs/cli/index.mdx | 36 + .../cli/list-sandboxes/index.mdx | 55 + .../cli/shutdown-sandboxes/index.mdx | 45 + .../analyze-data-with-ai/index.mdx | 532 ++++ .../pre-installed-libraries/index.mdx | 36 + .../create-charts-visualizations/index.mdx | 13 + .../interactive-charts/index.mdx | 177 ++ .../static-charts/index.mdx | 68 + .../code-interpreting/streaming/index.mdx | 142 + .../supported-languages/bash/index.mdx | 23 + .../supported-languages/index.mdx | 17 + .../supported-languages/java/index.mdx | 23 + .../supported-languages/javascript/index.mdx | 78 + .../supported-languages/python/index.mdx | 22 + .../supported-languages/r/index.mdx | 24 + .../commands/background/index.mdx | 45 + .../(docs)/mintlify-docs/commands/index.mdx | 24 + .../commands/streaming/index.mdx | 32 + .../(docs)/mintlify-docs/cookbook/index.mdx | 5 + .../src/app/(docs)/mintlify-docs/docs.json | 2612 +++++++++++++++++ .../src/app/(docs)/mintlify-docs/favicon.ico | Bin 0 -> 4286 bytes .../src/app/(docs)/mintlify-docs/favicon.jpeg | Bin 0 -> 5485 bytes .../src/app/(docs)/mintlify-docs/favicon.svg | 49 + .../filesystem/download/index.mdx | 70 + .../(docs)/mintlify-docs/filesystem/index.mdx | 13 + .../mintlify-docs/filesystem/info/index.mdx | 116 + .../filesystem/read-write/index.mdx | 68 + .../mintlify-docs/filesystem/upload/index.mdx | 161 + .../mintlify-docs/filesystem/watch/index.mdx | 98 + .../images/ai-app-e2b-sandbox-model.png | Bin 0 -> 18794 bytes .../images/analyze-data-chart.png | Bin 0 -> 89377 bytes .../images/byoc-architecture-diagram.png | Bin 0 -> 79583 bytes .../mintlify-docs/images/custom-sandbox.png | Bin 0 -> 39794 bytes .../(docs)/mintlify-docs/images/diagram.png | Bin 0 -> 66214 bytes .../(docs)/mintlify-docs/images/diagram.svg | 463 +++ .../images/hello-world-chart.png | Bin 0 -> 21910 bytes .../mintlify-docs/images/logos/node.svg | 4 + .../mintlify-docs/images/logos/openai.svg | 12 + .../mintlify-docs/images/logos/python.svg | 13 + .../images/sandbox-build-output.png | Bin 0 -> 96991 bytes .../mintlify-docs/images/static-chart.png | Bin 0 -> 18852 bytes .../src/app/(docs)/mintlify-docs/index.mdx | 40 + .../legacy/cli/commands/index.mdx | 283 ++ .../legacy/cli/installation/index.mdx | 27 + .../code-interpreter/examples/index.mdx | 149 + .../code-interpreter/execution/index.mdx | 198 ++ .../code-interpreter/installation/index.mdx | 61 + .../legacy/code-interpreter/kernels/index.mdx | 30 + .../code-interpreter/template/index.mdx | 61 + .../legacy/examples/clone-repo/index.mdx | 7 + .../legacy/getting-help/index.mdx | 12 + .../legacy/getting-started/api-key/index.mdx | 32 + .../getting-started/installation/index.mdx | 46 + .../index.mdx | 59 + .../legacy/guide/beta-migration/index.mdx | 705 +++++ .../legacy/guide/custom-sandbox/index.mdx | 199 ++ .../legacy/hello-world/js/index.mdx | 308 ++ .../legacy/hello-world/py/index.mdx | 252 ++ .../app/(docs)/mintlify-docs/legacy/index.mdx | 53 + .../legacy/open-source/index.mdx | 15 + .../mintlify-docs/legacy/pricing/index.mdx | 70 + .../legacy/sandbox/api/cwd/index.mdx | 136 + .../legacy/sandbox/api/debugging/index.mdx | 79 + .../legacy/sandbox/api/download/index.mdx | 40 + .../legacy/sandbox/api/envs/index.mdx | 79 + .../legacy/sandbox/api/filesystem/index.mdx | 276 ++ .../legacy/sandbox/api/metadata/index.mdx | 66 + .../legacy/sandbox/api/process/index.mdx | 269 ++ .../legacy/sandbox/api/reconnect/index.mdx | 110 + .../legacy/sandbox/api/timeouts/index.mdx | 100 + .../legacy/sandbox/api/upload/index.mdx | 56 + .../legacy/sandbox/api/url/index.mdx | 60 + .../legacy/sandbox/compute/index.mdx | 31 + .../legacy/sandbox/custom/index.mdx | 55 + .../legacy/sandbox/overview/index.mdx | 81 + .../sandbox/templates/overview/index.mdx | 68 + .../sandbox/templates/template-file/index.mdx | 49 + .../mintlify-docs/legacy/supported/index.mdx | 15 + .../(docs)/mintlify-docs/logo/logo_dark.svg | 1 + .../(docs)/mintlify-docs/logo/logo_light.svg | 1 + .../app/(docs)/mintlify-docs/logo/white.svg | 7 + .../mintlify-docs/migration/v2/index.mdx | 146 + .../quickstart/connect-llms/index.mdx | 807 +++++ .../(docs)/mintlify-docs/quickstart/index.mdx | 69 + .../install-custom-packages/index.mdx | 189 ++ .../upload-download-files/index.mdx | 150 + .../customize-cpu-ram/index.mdx | 18 + .../mintlify-docs/sandbox-template/index.mdx | 138 + .../sandbox-template/ready-cmd/index.mdx | 51 + .../sandbox-template/start-cmd/index.mdx | 47 + .../sandbox/connect-bucket/index.mdx | 166 ++ .../mintlify-docs/sandbox/connect/index.mdx | 90 + .../sandbox/environment-variables/index.mdx | 123 + .../(docs)/mintlify-docs/sandbox/index.mdx | 132 + .../sandbox/internet-access/index.mdx | 160 + .../sandbox/lifecycle-events-api/index.mdx | 151 + .../lifecycle-events-webhooks/index.mdx | 270 ++ .../mintlify-docs/sandbox/list/index.mdx | 339 +++ .../mintlify-docs/sandbox/metadata/index.mdx | 59 + .../mintlify-docs/sandbox/metrics/index.mdx | 110 + .../sandbox/persistence/index.mdx | 277 ++ .../sandbox/rate-limits/index.mdx | 128 + .../sdk-reference/cli/v1.0.0/auth/index.mdx | 62 + .../cli/v1.0.0/sandbox/index.mdx | 93 + .../cli/v1.0.0/template/index.mdx | 94 + .../sdk-reference/cli/v1.0.1/auth/index.mdx | 62 + .../cli/v1.0.1/sandbox/index.mdx | 93 + .../cli/v1.0.1/template/index.mdx | 94 + .../sdk-reference/cli/v1.0.10/auth/index.mdx | 62 + .../cli/v1.0.10/sandbox/index.mdx | 93 + .../cli/v1.0.10/template/index.mdx | 136 + .../sdk-reference/cli/v1.0.2/auth/index.mdx | 62 + .../cli/v1.0.2/sandbox/index.mdx | 93 + .../cli/v1.0.2/template/index.mdx | 94 + .../sdk-reference/cli/v1.0.3/auth/index.mdx | 62 + .../cli/v1.0.3/sandbox/index.mdx | 93 + .../cli/v1.0.3/template/index.mdx | 94 + .../sdk-reference/cli/v1.0.4/auth/index.mdx | 62 + .../cli/v1.0.4/sandbox/index.mdx | 93 + .../cli/v1.0.4/template/index.mdx | 94 + .../sdk-reference/cli/v1.0.5/auth/index.mdx | 62 + .../cli/v1.0.5/sandbox/index.mdx | 93 + .../cli/v1.0.5/template/index.mdx | 94 + .../sdk-reference/cli/v1.0.6/auth/index.mdx | 62 + .../cli/v1.0.6/sandbox/index.mdx | 93 + .../cli/v1.0.6/template/index.mdx | 94 + .../sdk-reference/cli/v1.0.7/auth/index.mdx | 62 + .../cli/v1.0.7/sandbox/index.mdx | 93 + .../cli/v1.0.7/template/index.mdx | 136 + .../sdk-reference/cli/v1.0.8/auth/index.mdx | 62 + .../cli/v1.0.8/sandbox/index.mdx | 93 + .../cli/v1.0.8/template/index.mdx | 136 + .../sdk-reference/cli/v1.0.9/auth/index.mdx | 62 + .../cli/v1.0.9/sandbox/index.mdx | 93 + .../cli/v1.0.9/template/index.mdx | 136 + .../sdk-reference/cli/v1.2.0/auth/index.mdx | 62 + .../cli/v1.2.0/sandbox/index.mdx | 93 + .../cli/v1.2.0/template/index.mdx | 136 + .../sdk-reference/cli/v1.2.1/auth/index.mdx | 62 + .../cli/v1.2.1/sandbox/index.mdx | 93 + .../cli/v1.2.1/template/index.mdx | 136 + .../sdk-reference/cli/v1.2.2/auth/index.mdx | 62 + .../cli/v1.2.2/sandbox/index.mdx | 93 + .../cli/v1.2.2/template/index.mdx | 136 + .../sdk-reference/cli/v1.2.3/auth/index.mdx | 62 + .../cli/v1.2.3/sandbox/index.mdx | 93 + .../cli/v1.2.3/template/index.mdx | 136 + .../sdk-reference/cli/v1.3.0/auth/index.mdx | 62 + .../cli/v1.3.0/sandbox/index.mdx | 93 + .../cli/v1.3.0/template/index.mdx | 136 + .../sdk-reference/cli/v1.3.1/auth/index.mdx | 62 + .../cli/v1.3.1/sandbox/index.mdx | 93 + .../cli/v1.3.1/template/index.mdx | 136 + .../sdk-reference/cli/v1.3.2/auth/index.mdx | 62 + .../cli/v1.3.2/sandbox/index.mdx | 93 + .../cli/v1.3.2/template/index.mdx | 136 + .../sdk-reference/cli/v1.3.3/auth/index.mdx | 62 + .../cli/v1.3.3/sandbox/index.mdx | 93 + .../cli/v1.3.3/template/index.mdx | 136 + .../sdk-reference/cli/v1.3.4/auth/index.mdx | 62 + .../cli/v1.3.4/sandbox/index.mdx | 93 + .../cli/v1.3.4/template/index.mdx | 136 + .../sdk-reference/cli/v1.4.0/auth/index.mdx | 62 + .../cli/v1.4.0/sandbox/index.mdx | 93 + .../cli/v1.4.0/template/index.mdx | 136 + .../sdk-reference/cli/v1.4.1/auth/index.mdx | 62 + .../cli/v1.4.1/sandbox/index.mdx | 93 + .../cli/v1.4.1/template/index.mdx | 137 + .../sdk-reference/cli/v1.4.2/auth/index.mdx | 62 + .../cli/v1.4.2/sandbox/index.mdx | 93 + .../cli/v1.4.2/template/index.mdx | 137 + .../sdk-reference/cli/v1.4.3/auth/index.mdx | 62 + .../cli/v1.4.3/sandbox/index.mdx | 93 + .../cli/v1.4.3/template/index.mdx | 137 + .../sdk-reference/cli/v1.5.0/auth/index.mdx | 62 + .../cli/v1.5.0/sandbox/index.mdx | 93 + .../cli/v1.5.0/template/index.mdx | 138 + .../sdk-reference/cli/v1.5.1/auth/index.mdx | 62 + .../cli/v1.5.1/sandbox/index.mdx | 93 + .../cli/v1.5.1/template/index.mdx | 138 + .../sdk-reference/cli/v1.5.2/auth/index.mdx | 62 + .../cli/v1.5.2/sandbox/index.mdx | 93 + .../cli/v1.5.2/template/index.mdx | 138 + .../sdk-reference/cli/v1.6.0/auth/index.mdx | 62 + .../cli/v1.6.0/sandbox/index.mdx | 93 + .../cli/v1.6.0/template/index.mdx | 138 + .../sdk-reference/cli/v1.7.0/auth/index.mdx | 62 + .../cli/v1.7.0/sandbox/index.mdx | 93 + .../cli/v1.7.0/template/index.mdx | 138 + .../sdk-reference/cli/v1.8.0/auth/index.mdx | 62 + .../cli/v1.8.0/sandbox/index.mdx | 93 + .../cli/v1.8.0/template/index.mdx | 138 + .../sdk-reference/cli/v1.9.0/auth/index.mdx | 62 + .../cli/v1.9.0/sandbox/index.mdx | 111 + .../cli/v1.9.0/template/index.mdx | 138 + .../sdk-reference/cli/v1.9.1/auth/index.mdx | 62 + .../cli/v1.9.1/sandbox/index.mdx | 111 + .../cli/v1.9.1/template/index.mdx | 138 + .../sdk-reference/cli/v1.9.2/auth/index.mdx | 62 + .../cli/v1.9.2/sandbox/index.mdx | 111 + .../cli/v1.9.2/template/index.mdx | 138 + .../sdk-reference/cli/v2.0.0/auth/index.mdx | 62 + .../cli/v2.0.0/sandbox/index.mdx | 118 + .../cli/v2.0.0/template/index.mdx | 138 + .../sdk-reference/cli/v2.0.1/auth/index.mdx | 62 + .../cli/v2.0.1/sandbox/index.mdx | 118 + .../cli/v2.0.1/template/index.mdx | 138 + .../sdk-reference/cli/v2.0.2/auth/index.mdx | 62 + .../cli/v2.0.2/sandbox/index.mdx | 136 + .../cli/v2.0.2/template/index.mdx | 138 + .../sdk-reference/cli/v2.0.3/auth/index.mdx | 62 + .../cli/v2.0.3/sandbox/index.mdx | 136 + .../cli/v2.0.3/template/index.mdx | 138 + .../sdk-reference/cli/v2.1.0/auth/index.mdx | 62 + .../cli/v2.1.0/sandbox/index.mdx | 139 + .../cli/v2.1.0/template/index.mdx | 139 + .../sdk-reference/cli/v2.2.0/auth/index.mdx | 62 + .../cli/v2.2.0/sandbox/index.mdx | 139 + .../cli/v2.2.0/template/index.mdx | 139 + .../v1.0.4/charts/index.mdx | 244 ++ .../v1.0.4/consts/index.mdx | 17 + .../v1.0.4/index/index.mdx | 107 + .../v1.0.4/messaging/index.mdx | 330 +++ .../v1.0.4/sandbox/index.mdx | 316 ++ .../v1.1.0/charts/index.mdx | 244 ++ .../v1.1.0/consts/index.mdx | 17 + .../v1.1.0/index/index.mdx | 107 + .../v1.1.0/messaging/index.mdx | 330 +++ .../v1.1.0/sandbox/index.mdx | 316 ++ .../v1.1.1/charts/index.mdx | 244 ++ .../v1.1.1/consts/index.mdx | 17 + .../v1.1.1/index/index.mdx | 107 + .../v1.1.1/messaging/index.mdx | 330 +++ .../v1.1.1/sandbox/index.mdx | 316 ++ .../v1.2.0/charts/index.mdx | 244 ++ .../v1.2.0/consts/index.mdx | 17 + .../v1.2.0/index/index.mdx | 107 + .../v1.2.0/messaging/index.mdx | 330 +++ .../v1.2.0/sandbox/index.mdx | 316 ++ .../v1.5.0/charts/index.mdx | 244 ++ .../v1.5.0/consts/index.mdx | 17 + .../v1.5.0/index/index.mdx | 107 + .../v1.5.0/messaging/index.mdx | 330 +++ .../v1.5.0/sandbox/index.mdx | 316 ++ .../v1.5.1/charts/index.mdx | 244 ++ .../v1.5.1/consts/index.mdx | 17 + .../v1.5.1/index/index.mdx | 107 + .../v1.5.1/messaging/index.mdx | 330 +++ .../v1.5.1/sandbox/index.mdx | 316 ++ .../v2.0.0/charts/index.mdx | 244 ++ .../v2.0.0/consts/index.mdx | 17 + .../v2.0.0/index/index.mdx | 107 + .../v2.0.0/messaging/index.mdx | 330 +++ .../v2.0.0/sandbox/index.mdx | 316 ++ .../v1.0.1/sandbox/index.mdx | 726 +++++ .../v1.0.2/sandbox/index.mdx | 726 +++++ .../v1.0.3/sandbox/index.mdx | 726 +++++ .../v1.0.4/sandbox/index.mdx | 726 +++++ .../v1.0.5/sandbox/index.mdx | 726 +++++ .../v1.1.0/sandbox/index.mdx | 726 +++++ .../v1.1.1/sandbox/index.mdx | 726 +++++ .../v1.2.0/sandbox/index.mdx | 726 +++++ .../v1.2.1/sandbox/index.mdx | 726 +++++ .../v1.5.0/sandbox/index.mdx | 726 +++++ .../v1.5.1/sandbox/index.mdx | 726 +++++ .../v1.5.2/sandbox/index.mdx | 726 +++++ .../v2.0.0/sandbox/index.mdx | 726 +++++ .../desktop-js-sdk/v1.0.1/sandbox/index.mdx | 418 +++ .../desktop-js-sdk/v1.0.2/sandbox/index.mdx | 418 +++ .../desktop-js-sdk/v1.0.3/sandbox/index.mdx | 437 +++ .../desktop-js-sdk/v1.1.1/sandbox/index.mdx | 437 +++ .../desktop-js-sdk/v1.2.0/sandbox/index.mdx | 437 +++ .../desktop-js-sdk/v1.3.0/sandbox/index.mdx | 413 +++ .../desktop-js-sdk/v1.4.0/sandbox/index.mdx | 446 +++ .../desktop-js-sdk/v1.5.0/sandbox/index.mdx | 482 +++ .../desktop-js-sdk/v1.6.0/sandbox/index.mdx | 482 +++ .../desktop-js-sdk/v1.6.1/sandbox/index.mdx | 482 +++ .../desktop-js-sdk/v1.6.2/sandbox/index.mdx | 510 ++++ .../desktop-js-sdk/v1.7.0/sandbox/index.mdx | 510 ++++ .../desktop-js-sdk/v1.7.1/sandbox/index.mdx | 510 ++++ .../desktop-js-sdk/v1.7.2/sandbox/index.mdx | 564 ++++ .../desktop-js-sdk/v1.7.3/sandbox/index.mdx | 564 ++++ .../desktop-js-sdk/v1.8.0/sandbox/index.mdx | 564 ++++ .../desktop-js-sdk/v1.8.1/sandbox/index.mdx | 564 ++++ .../desktop-js-sdk/v1.9.0/sandbox/index.mdx | 583 ++++ .../desktop-js-sdk/v1.9.1/sandbox/index.mdx | 583 ++++ .../desktop-js-sdk/v1.9.2/sandbox/index.mdx | 583 ++++ .../desktop-js-sdk/v2.0.0/sandbox/index.mdx | 696 +++++ .../desktop-js-sdk/v2.0.1/sandbox/index.mdx | 696 +++++ .../v1.0.1/sandbox/index.mdx | 202 ++ .../v1.0.2/sandbox/index.mdx | 232 ++ .../v1.0.3/sandbox/index.mdx | 232 ++ .../v1.1.1/sandbox/index.mdx | 232 ++ .../v1.2.0/sandbox/index.mdx | 232 ++ .../v1.3.0/sandbox/index.mdx | 259 ++ .../v1.4.0/sandbox/index.mdx | 277 ++ .../v1.5.0/sandbox/index.mdx | 277 ++ .../v1.5.1/sandbox/index.mdx | 277 ++ .../v1.5.2/sandbox/index.mdx | 268 ++ .../v1.6.0/sandbox/index.mdx | 268 ++ .../v1.6.1/sandbox/index.mdx | 268 ++ .../v1.6.2/sandbox/index.mdx | 295 ++ .../v1.6.3/sandbox/index.mdx | 295 ++ .../v1.6.4/sandbox/index.mdx | 295 ++ .../v1.6.5/sandbox/index.mdx | 295 ++ .../v1.7.0/sandbox/index.mdx | 304 ++ .../v1.7.1/sandbox/index.mdx | 304 ++ .../v1.7.2/sandbox/index.mdx | 306 ++ .../v1.7.3/sandbox/index.mdx | 306 ++ .../v1.7.4/sandbox/index.mdx | 306 ++ .../v2.0.0/sandbox/index.mdx | 345 +++ .../v2.0.1/sandbox/index.mdx | 345 +++ .../mintlify-docs/sdk-reference/index.mdx | 7 + .../js-sdk/v1.0.0/errors/index.mdx | 208 ++ .../js-sdk/v1.0.0/filesystem/index.mdx | 520 ++++ .../js-sdk/v1.0.0/sandbox/index.mdx | 583 ++++ .../js-sdk/v1.0.1/errors/index.mdx | 208 ++ .../js-sdk/v1.0.1/filesystem/index.mdx | 520 ++++ .../js-sdk/v1.0.1/sandbox/index.mdx | 583 ++++ .../js-sdk/v1.0.2/errors/index.mdx | 208 ++ .../js-sdk/v1.0.2/filesystem/index.mdx | 520 ++++ .../js-sdk/v1.0.2/sandbox/index.mdx | 583 ++++ .../js-sdk/v1.0.3/errors/index.mdx | 233 ++ .../js-sdk/v1.0.3/filesystem/index.mdx | 520 ++++ .../js-sdk/v1.0.3/sandbox/index.mdx | 583 ++++ .../js-sdk/v1.0.4/errors/index.mdx | 233 ++ .../js-sdk/v1.0.4/filesystem/index.mdx | 520 ++++ .../js-sdk/v1.0.4/sandbox/index.mdx | 583 ++++ .../js-sdk/v1.0.5/commands/index.mdx | 487 +++ .../js-sdk/v1.0.5/errors/index.mdx | 215 ++ .../js-sdk/v1.0.5/filesystem/index.mdx | 431 +++ .../js-sdk/v1.0.5/sandbox/index.mdx | 502 ++++ .../js-sdk/v1.0.6/commands/index.mdx | 487 +++ .../js-sdk/v1.0.6/errors/index.mdx | 215 ++ .../js-sdk/v1.0.6/filesystem/index.mdx | 439 +++ .../js-sdk/v1.0.6/sandbox/index.mdx | 502 ++++ .../js-sdk/v1.0.7/commands/index.mdx | 487 +++ .../js-sdk/v1.0.7/errors/index.mdx | 215 ++ .../js-sdk/v1.0.7/filesystem/index.mdx | 439 +++ .../js-sdk/v1.0.7/sandbox/index.mdx | 502 ++++ .../js-sdk/v1.1.0/commands/index.mdx | 487 +++ .../js-sdk/v1.1.0/errors/index.mdx | 215 ++ .../js-sdk/v1.1.0/filesystem/index.mdx | 473 +++ .../js-sdk/v1.1.0/sandbox/index.mdx | 502 ++++ .../js-sdk/v1.1.1/commands/index.mdx | 487 +++ .../js-sdk/v1.1.1/errors/index.mdx | 215 ++ .../js-sdk/v1.1.1/filesystem/index.mdx | 473 +++ .../js-sdk/v1.1.1/sandbox/index.mdx | 502 ++++ .../js-sdk/v1.10.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.10.0/errors/index.mdx | 215 ++ .../js-sdk/v1.10.0/filesystem/index.mdx | 626 ++++ .../js-sdk/v1.10.0/sandbox/index.mdx | 608 ++++ .../js-sdk/v1.11.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.11.0/errors/index.mdx | 215 ++ .../js-sdk/v1.11.0/filesystem/index.mdx | 626 ++++ .../js-sdk/v1.11.0/sandbox/index.mdx | 649 ++++ .../js-sdk/v1.12.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.12.0/errors/index.mdx | 215 ++ .../js-sdk/v1.12.0/filesystem/index.mdx | 626 ++++ .../js-sdk/v1.12.0/sandbox/index.mdx | 663 +++++ .../js-sdk/v1.13.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.13.0/errors/index.mdx | 215 ++ .../js-sdk/v1.13.0/filesystem/index.mdx | 626 ++++ .../js-sdk/v1.13.0/sandbox/index.mdx | 648 ++++ .../js-sdk/v1.13.1/commands/index.mdx | 508 ++++ .../js-sdk/v1.13.1/errors/index.mdx | 215 ++ .../js-sdk/v1.13.1/filesystem/index.mdx | 626 ++++ .../js-sdk/v1.13.1/sandbox/index.mdx | 648 ++++ .../js-sdk/v1.13.2/commands/index.mdx | 508 ++++ .../js-sdk/v1.13.2/errors/index.mdx | 215 ++ .../js-sdk/v1.13.2/filesystem/index.mdx | 626 ++++ .../js-sdk/v1.13.2/sandbox/index.mdx | 648 ++++ .../js-sdk/v1.2.0/commands/index.mdx | 487 +++ .../js-sdk/v1.2.0/errors/index.mdx | 215 ++ .../js-sdk/v1.2.0/filesystem/index.mdx | 473 +++ .../js-sdk/v1.2.0/sandbox/index.mdx | 502 ++++ .../js-sdk/v1.2.1/commands/index.mdx | 487 +++ .../js-sdk/v1.2.1/errors/index.mdx | 215 ++ .../js-sdk/v1.2.1/filesystem/index.mdx | 473 +++ .../js-sdk/v1.2.1/sandbox/index.mdx | 543 ++++ .../js-sdk/v1.2.2/commands/index.mdx | 487 +++ .../js-sdk/v1.2.2/errors/index.mdx | 215 ++ .../js-sdk/v1.2.2/filesystem/index.mdx | 473 +++ .../js-sdk/v1.2.2/sandbox/index.mdx | 551 ++++ .../js-sdk/v1.2.3/commands/index.mdx | 487 +++ .../js-sdk/v1.2.3/errors/index.mdx | 215 ++ .../js-sdk/v1.2.3/filesystem/index.mdx | 473 +++ .../js-sdk/v1.2.3/sandbox/index.mdx | 551 ++++ .../js-sdk/v1.2.4/commands/index.mdx | 487 +++ .../js-sdk/v1.2.4/errors/index.mdx | 215 ++ .../js-sdk/v1.2.4/filesystem/index.mdx | 473 +++ .../js-sdk/v1.2.4/sandbox/index.mdx | 551 ++++ .../js-sdk/v1.2.5/commands/index.mdx | 487 +++ .../js-sdk/v1.2.5/errors/index.mdx | 215 ++ .../js-sdk/v1.2.5/filesystem/index.mdx | 473 +++ .../js-sdk/v1.2.5/sandbox/index.mdx | 551 ++++ .../js-sdk/v1.3.0/commands/index.mdx | 487 +++ .../js-sdk/v1.3.0/errors/index.mdx | 215 ++ .../js-sdk/v1.3.0/filesystem/index.mdx | 473 +++ .../js-sdk/v1.3.0/sandbox/index.mdx | 551 ++++ .../js-sdk/v1.4.0/commands/index.mdx | 487 +++ .../js-sdk/v1.4.0/errors/index.mdx | 215 ++ .../js-sdk/v1.4.0/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.4.0/sandbox/index.mdx | 551 ++++ .../js-sdk/v1.5.0/commands/index.mdx | 487 +++ .../js-sdk/v1.5.0/errors/index.mdx | 215 ++ .../js-sdk/v1.5.0/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.5.0/sandbox/index.mdx | 599 ++++ .../js-sdk/v1.5.1/commands/index.mdx | 508 ++++ .../js-sdk/v1.5.1/errors/index.mdx | 215 ++ .../js-sdk/v1.5.1/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.5.1/sandbox/index.mdx | 599 ++++ .../js-sdk/v1.5.2/commands/index.mdx | 508 ++++ .../js-sdk/v1.5.2/errors/index.mdx | 215 ++ .../js-sdk/v1.5.2/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.5.2/sandbox/index.mdx | 599 ++++ .../js-sdk/v1.5.3/commands/index.mdx | 508 ++++ .../js-sdk/v1.5.3/errors/index.mdx | 215 ++ .../js-sdk/v1.5.3/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.5.3/sandbox/index.mdx | 599 ++++ .../js-sdk/v1.6.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.6.0/errors/index.mdx | 215 ++ .../js-sdk/v1.6.0/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.6.0/sandbox/index.mdx | 607 ++++ .../js-sdk/v1.7.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.7.0/errors/index.mdx | 215 ++ .../js-sdk/v1.7.0/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.7.0/sandbox/index.mdx | 607 ++++ .../js-sdk/v1.7.1/commands/index.mdx | 508 ++++ .../js-sdk/v1.7.1/errors/index.mdx | 215 ++ .../js-sdk/v1.7.1/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.7.1/sandbox/index.mdx | 607 ++++ .../js-sdk/v1.8.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.8.0/errors/index.mdx | 215 ++ .../js-sdk/v1.8.0/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.8.0/sandbox/index.mdx | 607 ++++ .../js-sdk/v1.9.0/commands/index.mdx | 508 ++++ .../js-sdk/v1.9.0/errors/index.mdx | 215 ++ .../js-sdk/v1.9.0/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.9.0/sandbox/index.mdx | 608 ++++ .../js-sdk/v1.9.1/commands/index.mdx | 508 ++++ .../js-sdk/v1.9.1/errors/index.mdx | 215 ++ .../js-sdk/v1.9.1/filesystem/index.mdx | 513 ++++ .../js-sdk/v1.9.1/sandbox/index.mdx | 608 ++++ .../js-sdk/v2.0.0/commands/index.mdx | 508 ++++ .../js-sdk/v2.0.0/errors/index.mdx | 215 ++ .../js-sdk/v2.0.0/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.0.0/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.0.1/commands/index.mdx | 508 ++++ .../js-sdk/v2.0.1/errors/index.mdx | 215 ++ .../js-sdk/v2.0.1/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.0.1/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.0.2/commands/index.mdx | 508 ++++ .../js-sdk/v2.0.2/errors/index.mdx | 215 ++ .../js-sdk/v2.0.2/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.0.2/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.0.3/commands/index.mdx | 508 ++++ .../js-sdk/v2.0.3/errors/index.mdx | 215 ++ .../js-sdk/v2.0.3/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.0.3/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.1.0/commands/index.mdx | 508 ++++ .../js-sdk/v2.1.0/errors/index.mdx | 214 ++ .../js-sdk/v2.1.0/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.1.0/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.1.1/commands/index.mdx | 508 ++++ .../js-sdk/v2.1.1/errors/index.mdx | 214 ++ .../js-sdk/v2.1.1/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.1.1/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.1.2/commands/index.mdx | 508 ++++ .../js-sdk/v2.1.2/errors/index.mdx | 214 ++ .../js-sdk/v2.1.2/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.1.2/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.1.3/commands/index.mdx | 508 ++++ .../js-sdk/v2.1.3/errors/index.mdx | 214 ++ .../js-sdk/v2.1.3/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.1.3/sandbox/index.mdx | 682 +++++ .../js-sdk/v2.1.4/commands/index.mdx | 508 ++++ .../js-sdk/v2.1.4/errors/index.mdx | 220 ++ .../js-sdk/v2.1.4/filesystem/index.mdx | 626 ++++ .../js-sdk/v2.1.4/sandbox/index.mdx | 682 +++++ .../python-sdk/v1.0.0/exceptions/index.mdx | 79 + .../python-sdk/v1.0.0/sandbox_async/index.mdx | 928 ++++++ .../python-sdk/v1.0.0/sandbox_sync/index.mdx | 905 ++++++ .../python-sdk/v1.0.1/exceptions/index.mdx | 79 + .../python-sdk/v1.0.1/sandbox_async/index.mdx | 928 ++++++ .../python-sdk/v1.0.1/sandbox_sync/index.mdx | 905 ++++++ .../python-sdk/v1.0.2/exceptions/index.mdx | 88 + .../python-sdk/v1.0.2/sandbox_async/index.mdx | 928 ++++++ .../python-sdk/v1.0.2/sandbox_sync/index.mdx | 905 ++++++ .../python-sdk/v1.0.3/exceptions/index.mdx | 88 + .../python-sdk/v1.0.3/sandbox_async/index.mdx | 928 ++++++ .../python-sdk/v1.0.3/sandbox_sync/index.mdx | 905 ++++++ .../python-sdk/v1.0.4/exceptions/index.mdx | 88 + .../python-sdk/v1.0.4/sandbox_async/index.mdx | 928 ++++++ .../python-sdk/v1.0.4/sandbox_sync/index.mdx | 905 ++++++ .../python-sdk/v1.0.5/exceptions/index.mdx | 88 + .../python-sdk/v1.0.5/sandbox_async/index.mdx | 928 ++++++ .../python-sdk/v1.0.5/sandbox_sync/index.mdx | 905 ++++++ .../python-sdk/v1.0.6/exceptions/index.mdx | 88 + .../python-sdk/v1.0.6/sandbox_async/index.mdx | 930 ++++++ .../python-sdk/v1.0.6/sandbox_sync/index.mdx | 908 ++++++ .../python-sdk/v1.1.0/exceptions/index.mdx | 88 + .../python-sdk/v1.1.0/sandbox_async/index.mdx | 930 ++++++ .../python-sdk/v1.1.0/sandbox_sync/index.mdx | 908 ++++++ .../python-sdk/v1.10.0/exceptions/index.mdx | 88 + .../v1.10.0/sandbox_async/index.mdx | 1166 ++++++++ .../python-sdk/v1.10.0/sandbox_sync/index.mdx | 1130 +++++++ .../python-sdk/v1.11.0/exceptions/index.mdx | 88 + .../v1.11.0/sandbox_async/index.mdx | 1166 ++++++++ .../python-sdk/v1.11.0/sandbox_sync/index.mdx | 1130 +++++++ .../python-sdk/v1.11.1/exceptions/index.mdx | 88 + .../v1.11.1/sandbox_async/index.mdx | 1166 ++++++++ .../python-sdk/v1.11.1/sandbox_sync/index.mdx | 1130 +++++++ .../python-sdk/v1.2.0/exceptions/index.mdx | 88 + .../python-sdk/v1.2.0/sandbox_async/index.mdx | 970 ++++++ .../python-sdk/v1.2.0/sandbox_sync/index.mdx | 935 ++++++ .../python-sdk/v1.2.1/exceptions/index.mdx | 88 + .../python-sdk/v1.2.1/sandbox_async/index.mdx | 974 ++++++ .../python-sdk/v1.2.1/sandbox_sync/index.mdx | 939 ++++++ .../python-sdk/v1.3.0/exceptions/index.mdx | 88 + .../python-sdk/v1.3.0/sandbox_async/index.mdx | 974 ++++++ .../python-sdk/v1.3.0/sandbox_sync/index.mdx | 939 ++++++ .../python-sdk/v1.3.1/exceptions/index.mdx | 88 + .../python-sdk/v1.3.1/sandbox_async/index.mdx | 1018 +++++++ .../python-sdk/v1.3.1/sandbox_sync/index.mdx | 983 +++++++ .../python-sdk/v1.3.2/exceptions/index.mdx | 88 + .../python-sdk/v1.3.2/sandbox_async/index.mdx | 1018 +++++++ .../python-sdk/v1.3.2/sandbox_sync/index.mdx | 983 +++++++ .../python-sdk/v1.3.3/exceptions/index.mdx | 88 + .../python-sdk/v1.3.3/sandbox_async/index.mdx | 1022 +++++++ .../python-sdk/v1.3.3/sandbox_sync/index.mdx | 987 +++++++ .../python-sdk/v1.3.4/exceptions/index.mdx | 88 + .../python-sdk/v1.3.4/sandbox_async/index.mdx | 1022 +++++++ .../python-sdk/v1.3.4/sandbox_sync/index.mdx | 987 +++++++ .../python-sdk/v1.3.5/exceptions/index.mdx | 88 + .../python-sdk/v1.3.5/sandbox_async/index.mdx | 1034 +++++++ .../python-sdk/v1.3.5/sandbox_sync/index.mdx | 998 +++++++ .../python-sdk/v1.4.0/exceptions/index.mdx | 88 + .../python-sdk/v1.4.0/sandbox_async/index.mdx | 1036 +++++++ .../python-sdk/v1.4.0/sandbox_sync/index.mdx | 1000 +++++++ .../python-sdk/v1.5.0/exceptions/index.mdx | 88 + .../python-sdk/v1.5.0/sandbox_async/index.mdx | 1038 +++++++ .../python-sdk/v1.5.0/sandbox_sync/index.mdx | 1001 +++++++ .../python-sdk/v1.5.1/exceptions/index.mdx | 88 + .../python-sdk/v1.5.1/sandbox_async/index.mdx | 1038 +++++++ .../python-sdk/v1.5.1/sandbox_sync/index.mdx | 1001 +++++++ .../python-sdk/v1.5.2/exceptions/index.mdx | 88 + .../python-sdk/v1.5.2/sandbox_async/index.mdx | 1038 +++++++ .../python-sdk/v1.5.2/sandbox_sync/index.mdx | 1001 +++++++ .../python-sdk/v1.5.3/exceptions/index.mdx | 88 + .../python-sdk/v1.5.3/sandbox_async/index.mdx | 1038 +++++++ .../python-sdk/v1.5.3/sandbox_sync/index.mdx | 1001 +++++++ .../python-sdk/v1.5.4/exceptions/index.mdx | 88 + .../python-sdk/v1.5.4/sandbox_async/index.mdx | 1038 +++++++ .../python-sdk/v1.5.4/sandbox_sync/index.mdx | 1001 +++++++ .../python-sdk/v1.5.5/exceptions/index.mdx | 88 + .../python-sdk/v1.5.5/sandbox_async/index.mdx | 1038 +++++++ .../python-sdk/v1.5.5/sandbox_sync/index.mdx | 1001 +++++++ .../python-sdk/v1.5.6/exceptions/index.mdx | 88 + .../python-sdk/v1.5.6/sandbox_async/index.mdx | 1057 +++++++ .../python-sdk/v1.5.6/sandbox_sync/index.mdx | 1021 +++++++ .../python-sdk/v1.6.0/exceptions/index.mdx | 88 + .../python-sdk/v1.6.0/sandbox_async/index.mdx | 1057 +++++++ .../python-sdk/v1.6.0/sandbox_sync/index.mdx | 1021 +++++++ .../python-sdk/v1.7.0/exceptions/index.mdx | 88 + .../python-sdk/v1.7.0/sandbox_async/index.mdx | 1067 +++++++ .../python-sdk/v1.7.0/sandbox_sync/index.mdx | 1031 +++++++ .../python-sdk/v1.7.1/exceptions/index.mdx | 88 + .../python-sdk/v1.7.1/sandbox_async/index.mdx | 1067 +++++++ .../python-sdk/v1.7.1/sandbox_sync/index.mdx | 1031 +++++++ .../python-sdk/v1.8.0/exceptions/index.mdx | 88 + .../python-sdk/v1.8.0/sandbox_async/index.mdx | 1088 +++++++ .../python-sdk/v1.8.0/sandbox_sync/index.mdx | 1052 +++++++ .../python-sdk/v1.9.0/exceptions/index.mdx | 88 + .../python-sdk/v1.9.0/sandbox_async/index.mdx | 1164 ++++++++ .../python-sdk/v1.9.0/sandbox_sync/index.mdx | 1128 +++++++ .../python-sdk/v2.0.0/exceptions/index.mdx | 88 + .../python-sdk/v2.0.0/sandbox_async/index.mdx | 1285 ++++++++ .../python-sdk/v2.0.0/sandbox_sync/index.mdx | 1244 ++++++++ .../python-sdk/v2.0.1/exceptions/index.mdx | 88 + .../python-sdk/v2.0.1/sandbox_async/index.mdx | 1285 ++++++++ .../python-sdk/v2.0.1/sandbox_sync/index.mdx | 1244 ++++++++ .../python-sdk/v2.0.2/exceptions/index.mdx | 88 + .../python-sdk/v2.0.2/sandbox_async/index.mdx | 1285 ++++++++ .../python-sdk/v2.0.2/sandbox_sync/index.mdx | 1244 ++++++++ .../python-sdk/v2.1.0/exceptions/index.mdx | 88 + .../python-sdk/v2.1.0/sandbox_async/index.mdx | 1285 ++++++++ .../python-sdk/v2.1.0/sandbox_sync/index.mdx | 1244 ++++++++ .../python-sdk/v2.1.1/exceptions/index.mdx | 88 + .../python-sdk/v2.1.1/sandbox_async/index.mdx | 1285 ++++++++ .../python-sdk/v2.1.1/sandbox_sync/index.mdx | 1244 ++++++++ .../python-sdk/v2.1.2/exceptions/index.mdx | 88 + .../python-sdk/v2.1.2/sandbox_async/index.mdx | 1285 ++++++++ .../python-sdk/v2.1.2/sandbox_sync/index.mdx | 1244 ++++++++ .../python-sdk/v2.1.3/exceptions/index.mdx | 88 + .../python-sdk/v2.1.3/sandbox_async/index.mdx | 1285 ++++++++ .../python-sdk/v2.1.3/sandbox_sync/index.mdx | 1244 ++++++++ .../(docs)/mintlify-docs/sdk_navigation.json | 2398 +++++++++++++++ .../snippets/CodeInterpreting.jsx | 37 + .../mintlify-docs/snippets/Concepts.jsx | 43 + .../mintlify-docs/snippets/Quickstart.jsx | 37 + .../mintlify-docs/snippets/SandboxSpec.mdx | 125 + .../src/app/(docs)/mintlify-docs/style.css | 28 + .../(docs)/mintlify-docs/support/index.mdx | 24 + .../sdks/workers-edge-runtime/index.mdx | 5 + .../build-authentication-error/index.mdx | 73 + 612 files changed, 224457 insertions(+) create mode 100644 apps/web/src/app/(docs)/mintlify-docs/README.md create mode 100644 apps/web/src/app/(docs)/mintlify-docs/_mint.json create mode 100644 apps/web/src/app/(docs)/mintlify-docs/api-key/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/broken_links_report.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/byoc/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/cli/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/cli/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/cli/list-sandboxes/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/cli/shutdown-sandboxes/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/interactive-charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/static-charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/bash/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/java/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/javascript/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/python/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/r/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/commands/streaming/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/cookbook/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/docs.json create mode 100644 apps/web/src/app/(docs)/mintlify-docs/favicon.ico create mode 100644 apps/web/src/app/(docs)/mintlify-docs/favicon.jpeg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/favicon.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/filesystem/download/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/filesystem/info/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/filesystem/read-write/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/filesystem/upload/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/ai-app-e2b-sandbox-model.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/analyze-data-chart.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/byoc-architecture-diagram.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/custom-sandbox.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/diagram.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/diagram.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/hello-world-chart.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/logos/node.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/logos/openai.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/logos/python.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/sandbox-build-output.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/images/static-chart.png create mode 100644 apps/web/src/app/(docs)/mintlify-docs/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/cli/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/cli/installation/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/examples/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/execution/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/installation/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/kernels/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/examples/clone-repo/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/getting-help/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/api-key/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/installation/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-code-interpreter-language-runtimes/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-migration/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/js/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/open-source/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/pricing/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/compute/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/custom/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/overview/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/template-file/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/legacy/supported/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/logo/logo_dark.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/logo/logo_light.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/logo/white.svg create mode 100644 apps/web/src/app/(docs)/mintlify-docs/migration/v2/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/quickstart/connect-llms/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/quickstart/install-custom-packages/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/quickstart/upload-download-files/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox-template/customize-cpu-ram/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/connect-bucket/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-api/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-webhooks/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sandbox/rate-limits/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/auth/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/template/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/index/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/consts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/index/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/messaging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/consts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/index/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/messaging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/consts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/index/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/messaging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/consts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/index/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/messaging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/consts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/index/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/messaging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/charts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/consts/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/index/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/messaging/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.5/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v2.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.1.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.2.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.3.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.4.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.5.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.1.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.2.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.3.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.4.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.5/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/commands/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/errors/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/filesystem/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/sandbox/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/exceptions/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_async/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_sync/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/sdk_navigation.json create mode 100644 apps/web/src/app/(docs)/mintlify-docs/snippets/CodeInterpreting.jsx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/snippets/Concepts.jsx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/snippets/Quickstart.jsx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/snippets/SandboxSpec.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/style.css create mode 100644 apps/web/src/app/(docs)/mintlify-docs/support/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/troubleshooting/sdks/workers-edge-runtime/index.mdx create mode 100644 apps/web/src/app/(docs)/mintlify-docs/troubleshooting/templates/build-authentication-error/index.mdx diff --git a/apps/web/src/app/(docs)/mintlify-docs/README.md b/apps/web/src/app/(docs)/mintlify-docs/README.md new file mode 100644 index 0000000000..4cbe0750c0 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/README.md @@ -0,0 +1,32 @@ +# Mintlify Starter Kit + +Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including + +- Guide pages +- Navigation +- Customizations +- API Reference pages +- Use of popular components + +### Development + +Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command + +``` +npm i -g mintlify +``` + +Run the following command at the root of your documentation (where mint.json is) + +``` +mintlify dev +``` + +### Publishing Changes + +Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. + +#### Troubleshooting + +- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. +- Page loads as a 404 - Make sure you are running in a folder with `mint.json` diff --git a/apps/web/src/app/(docs)/mintlify-docs/_mint.json b/apps/web/src/app/(docs)/mintlify-docs/_mint.json new file mode 100644 index 0000000000..407ced733c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/_mint.json @@ -0,0 +1,130 @@ +{ + "$schema": "https://mintlify.com/schema.json", + "name": "E2B Docs", + "logo": { + "dark": "/logo/white.svg", + "light": "/logo/white.svg" + }, + "favicon": "/favicon.jpeg", + "colors": { + "primary": "#ff8800", + "light": "#ff8800", + "dark": "#ffffff", + "anchors": { + "from": "#ff8800", + "to": "#ff8800" + }, + "background": { + "dark": "#000000", + "light": "#ffffff" + } + }, + "modeToggle": { + "default": "dark" + }, + "rounded": "sharp", + "topbarLinks": [ + { + "name": "SIGN IN", + "url": "https://e2b.dev/auth/sign-in?redirect_to=https%3A%2F%2Fe2b.dev%2Fdocs" + } + ], + "topbarCtaButton": { + "type": "github", + "url": "https://github.com/e2b-dev/e2b" + }, + "primaryTab": { + "name": "Docs" + }, + "tabs": [ + { + "name": "SDK Reference", + "url": "sdk" + } + ], + "anchors": [ + { + "name": "Documentation", + "icon": "book-open-cover", + "url": "https://e2b.dev/docs" + }, + { + "name": "Dashboard", + "icon": "house", + "url": "https://e2b.dev/dashboard" + } + ], + "navigation": [ + { + "group": "Get Started", + "pages": [ + "introduction", + { + "group": "Quickstart", + "pages": [ + "quickstart/get-started", + "quickstart/connect" + ] + } + ] + }, + { + "group": "Sandbox", + "pages": [ + "sandbox/lifestyle" + ] + }, + { + "group": "CLI", + "pages": [ + { + "group": "Auth", + "pages": [ + "sdk/cli/auth" + ] + }, + { + "group": "Sandbox", + "pages": [ + "sdk/sandbox/sandbox" + ] + } + ] + }, + { + "group": "JavaScript SDK", + "icon": "js", + "pages": [ + { + "group": "Commands", + "icon": "js", + "pages": [ + "sdk/javascript/commands/cmd" + ] + }, + { + "group": "Errors", + "icon": "js", + "pages": [ + "sdk/javascript/errors/auth" + ] + } + ] + } + ], + "font": { + "headings": { + "family": "IBM Plex Mono", + "weight": 700 + }, + "body": { + "family": "IBM Plex Mono", + "weight": 400 + } + }, + "footerSocials": { + "x": "https://x.com/mintlify", + "github": "https://github.com/mintlify", + "linkedin": "https://linkedin.com/company/mintlify" + } +} diff --git a/apps/web/src/app/(docs)/mintlify-docs/api-key/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/api-key/index.mdx new file mode 100644 index 0000000000..ce52f0884a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/api-key/index.mdx @@ -0,0 +1,41 @@ +--- +title: "API Key" +icon: "key" +--- + +To use the API key, you can either: + +- **Set the API key as the `E2B_API_KEY` environment variable** to avoid passing it each time you create a sandbox. +- Or pass it directly to the `Sandbox` constructor as shown below: + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create({ apiKey: 'YOUR_API_KEY' }) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create(api_key="YOUR_API_KEY") +``` + + +## Where to find API key + +You can get your API key at [dashboard](https://e2b.dev/dashboard?tab=keys). + +
+ +# Access Token + +The access token is used only in the CLI and is **not needed in the SDK**. There's no need to set it when logging into the CLI using `e2b auth login`. + + +To authenticate without the browser, you can set `E2B_ACCESS_TOKEN` as an environment variable. This is useful for CI/CD pipelines. + + +## Where to find Access token + +You can get your **Access token key** at the [dashboard](https://e2b.dev/dashboard/account). + diff --git a/apps/web/src/app/(docs)/mintlify-docs/broken_links_report.mdx b/apps/web/src/app/(docs)/mintlify-docs/broken_links_report.mdx new file mode 100644 index 0000000000..a3a48b754f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/broken_links_report.mdx @@ -0,0 +1,2 @@ +sandbox/metadata/index.mdx = https://e2b.dev/docs/sandbox/metadata + ⎿ the following page linked doesn't exist: [beta version of the SDK](/sandbox/installing-beta-sdks) = https://e2b.dev/docs/sandbox/installing-beta-sdks diff --git a/apps/web/src/app/(docs)/mintlify-docs/byoc/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/byoc/index.mdx new file mode 100644 index 0000000000..50b974fc15 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/byoc/index.mdx @@ -0,0 +1,70 @@ +--- +title: "BYOC (Bring Your Own Cloud)" +sidebarTitle: Bring Your Own Cloud +--- + +BYOC (Bring Your Own Cloud) allows you to deploy E2B sandboxes to your own cloud infrastructure within your VPC. + +BYOC is currently only available for AWS. We are working on adding support for Google Cloud and Azure. + + +BYOC is offered to enterprise customers only. +If you’re interested in BYOC offering, please book a call with our team [here](https://e2b.dev/contact) or contact us at [enterprise@e2b.dev](mailto:enterprise@e2b.dev). + + +## Architecture + +Sandbox templates, snapshots, and runtime logs are stored within the customer's BYOC VPC. +Anonymized system metrics such as cluster memory and cpu are sent to the E2B Cloud for observability and cluster management purposes. + +All potentially sensitive traffic, such as sandbox template build source files, +sandbox traffic, and logs, is transmitted directly from the client to the customer's BYOC VPC without ever touching the E2B Cloud infrastructure. + +### Glossary +- **BYOC VPC**: The customer's Virtual Private Network where the E2B sandboxes are deployed. For example your AWS account. +- **E2B Cloud**: The managed service that provides the E2B platform, observability and cluster management. +- **OAuth Provider**: Customer-managed service that provides user and E2B Cloud with access to the cluster. + + + + + +### BYOC Cluster Components +- **Orchestrator**: Represents a node that is responsible for managing sandboxes and their lifecycle. Optionally, it can also run the template builder component. +- **Edge Controller**: Routes traffic to sandboxes, exposes API for cluster management, and gRPC proxy used by E2B control plane to communicate with orchestrators. +- **Monitoring**: Collector that receives sandbox and build logs and system metrics from orchestrators and edge controllers. Only anonymized metrics are sent to the E2B Cloud for observability purposes. +- **Storage**: Persistent storage for sandbox templates, snapshots, and runtime logs. Image container repository for template images. + +## Onboarding + +Customers can initiate the onboarding process by reaching out to us. +Customers need to have a dedicated AWS account and know the region they will use. +After that, we will receive the IAM role needed for managing account resources. +For AWS account quota limits may need to be increased. + +Terraform configuration and machine images will be used for provisioning BYOC cluster. +When provisioning is done and running, we will create a new team under your E2B account that can be used by SDK/CLI the same way as it is hosted on E2B Cloud. + +## FAQ + + + + Cluster is forwarding anonymized metrics such as machine cpu/memory usage to E2B Control plane for advanced observability and alerting. + The whole observability stack is anonymized and does not contain any sensitive information. + + + A cluster can be scaled horizontally by adding more orchestrators and edge controllers. + The autoscaler is currently in V1 not capable of automatically scale orchestrator nodes that are needed for sandbox spawning. + This feature is coming in the next versions. + + + Yes. Load balancer that is handling all requests coming to sandbox can be configured as internal and VPC peering + with additional customer’s VPC can be configured so sandbox traffic can stay in the private network. + + + Data sent between the E2B Cloud and your BYOC VPC is encrypted using TLS. + + VPC peering can be established to allow direct communication between the E2B Cloud and your BYOC VPC. + When using VPC peering, the load balancer can be configured as private without a public IP address. + + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/cli/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/cli/auth/index.mdx new file mode 100644 index 0000000000..488b141cae --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/cli/auth/index.mdx @@ -0,0 +1,12 @@ +--- +title: "Authentication in CLI" +sidebarTitle: Authentication +--- + +You must authenticate with E2B CLI before using it. Run the following command to sign in into your E2B account: + + +```bash Terminal +e2b auth login +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/cli/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/cli/index.mdx new file mode 100644 index 0000000000..d84fb32e0c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/cli/index.mdx @@ -0,0 +1,36 @@ +--- +title: "E2B CLI" +sidebarTitle: Installation +--- + +E2B CLI is a command line tool that allows you to list, kill running sandboxes, and manage [sandbox templates](/sandbox-template). + +## Installation + +**Using Homebrew (on macOS)** + + +```bash Terminal +brew install e2b +``` + + +**Using NPM** + +You can install E2B CLI using the following command: + + +```bash Terminal +npm i -g @e2b/cli +``` + + +### Beta CLI + +The latest beta version of the CLI can be installed from NPM using the following command: + + +```bash Terminal +npm i -g @e2b/cli@beta +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/cli/list-sandboxes/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/cli/list-sandboxes/index.mdx new file mode 100644 index 0000000000..4ecc837450 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/cli/list-sandboxes/index.mdx @@ -0,0 +1,55 @@ +--- +title: "List sandboxes" +--- + +You can list all sandboxes using the following command: + + +```bash Terminal +e2b sandbox list +``` + + +This will return running sandboxes, you can specify `--state` to get paused or both. + +### Filter by state + +To filter the sandboxes by their state you can specify the `--state` flag, which can either be "**running**", "**paused**" or both. + +```bash +e2b sandbox list --state running,paused +``` + +### Filter by metadata + +To filter the sandboxes by their metadata, use the `--metadata` flag. + +```bash +e2b sandbox list --metadata key1=value1,key2=value2 +``` + +### List limit + +To limit the amount of sandboxes returned by the command, use the `--limit` flag. + +```bash +e2b sandbox list --limit 10 +``` + +By default, the command will return all sandboxes. + +### Output format + +To output the sandboxes in JSON format, use the `--format` flag. + +**Pretty print (default)** + +```bash +e2b sandbox list --format pretty +``` + +**JSON** + +```bash +e2b sandbox list --format json +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/cli/shutdown-sandboxes/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/cli/shutdown-sandboxes/index.mdx new file mode 100644 index 0000000000..54c12f908a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/cli/shutdown-sandboxes/index.mdx @@ -0,0 +1,45 @@ +--- +title: "Shutdown running sandboxes" +--- + +You can shutdown single or all running sandboxes with the E2B CLI. + +## Shutdown single or multiple sandboxes + +To shutdown a single or multiple sandboxes, run the following command: + + +```bash Terminal +e2b sandbox kill +``` + + +## Shutdown all sandboxes + +To shutdown all running sandboxes, run the following command: + + +```bash Terminal +e2b sandbox kill --all +``` + + +Further, you can filter the sandboxes to be shutdown by state, metadata or both. + + +```bash Terminal +e2b sandbox kill --all --state=running,paused +``` + + + +```bash Terminal +e2b sandbox kill --all --metadata=key=value +``` + + + +```bash Terminal +e2b sandbox kill --all --state=running,paused --metadata=key=value +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx new file mode 100644 index 0000000000..a0f65c2f1a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx @@ -0,0 +1,532 @@ +--- +title: "Analyze data with AI" +sidebarTitle: Overview +--- + +You can use E2B Sandbox to run AI-generated code to analyze data. Here's how the AI data analysis workflow usually looks like: +1. Your user has a dataset in CSV format or other formats. +2. You prompt the LLM to generate code (usually Python) based on the user's data. +3. The sandbox runs the AI-generated code and returns the results. +4. You display the results to the user. + +--- + +## Example: Analyze CSV file with E2B and Claude 3.5 Sonnet +This short example will show you how to use E2B Sandbox to run AI-generated code to analyze CSV data. + +### Table of Contents +1. [Install dependencies](#1-install-dependencies) +2. [Set your API keys](#2-set-your-api-keys) +3. [Download example CSV file](#3-download-example-csv-file) +4. [Initialize the sandbox and upload the dataset to the sandbox](#4-initialize-the-sandbox-and-upload-the-dataset-to-the-sandbox) +5. [Prepare the method for running AI-generated code](#5-prepare-the-method-for-running-ai-generated-code) +6. [Prepare the prompt and initialize Anthropic client](#6-prepare-the-prompt-and-initialize-anthropic-client) +7. [Connect the sandbox to the LLM with tool calling](#7-connect-the-sandbox-to-the-llm-with-tool-calling) +8. [Parse the LLM response and run the AI-generated code in the sandbox](#8-parse-the-llm-response-and-run-the-ai-generated-code-in-the-sandbox) +9. [Save the generated chart](#9-save-the-generated-chart) +10. [Run the code](#10-run-the-code) +11. [Full final code](#full-final-code) + +### 1. Install dependencies +Install the E2B SDK and Claude SDK to your project by running the following command in your terminal. + + +```bash JavaScript & TypeScript +npm i @e2b/code-interpreter @anthropic-ai/sdk dotenv +``` +```bash Python +pip install e2b-code-interpreter anthropic python-dotenv +``` + + +### 2. Set your API keys +1. Get your E2B API key from [E2B Dashboard](https://e2b.dev/dashboard?tab=keys). +2. Get your Claude API key from [Claude API Dashboard](https://console.anthropic.com/settings/keys). +3. Paste the keys into your `.env` file. + + +```bash .env +E2B_API_KEY=e2b_*** +ANTHROPIC_API_KEY=sk-ant-*** +``` + + +### 3. Download example CSV file +{/* We'll be using the publicly available [AirBnB NYC dataset](https://www.kaggle.com/datasets/dgomonov/new-york-city-airbnb-open-data). */} + +We'll be using the publicly available [dataset of about 10,000 movies](https://www.kaggle.com/datasets/muqarrishzaib/tmdb-10000-movies-dataset). +1. Click the "Download" button at the top of the page. +2. Select "Download as zip (2 MB)". +3. Unzip the file and you should see `dataset.csv` file. Move it to the root of your project. + + +### 4. Initialize the sandbox and upload the dataset to the sandbox +We'll upload the dataset from the third step to the sandbox and save it as `dataset.csv` file. + + +```js index.ts +import 'dotenv/config' +import fs from 'fs' +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox +const sbx = await Sandbox.create() + +// Upload the dataset to the sandbox +const content = fs.readFileSync('dataset.csv') +const datasetPathInSandbox = await sbx.files.write('dataset.csv', content) +``` +```python main.py +from dotenv import load_dotenv +load_dotenv() +from e2b_code_interpreter import Sandbox + +# Create sandbox +sbx = Sandbox.create() + +# Upload the dataset to the sandbox +dataset_path_in_sandbox = "" +with open("dataset.csv", "rb") as f: + dataset_path_in_sandbox = sbx.files.write("dataset.csv", f) + +``` + + +### 5. Prepare the method for running AI-generated code +Add the following code to the file. Here we're adding the method for code execution. + + +```js index.ts +// ... code from the previous step + +async function runAIGeneratedCode(aiGeneratedCode: string) { + console.log('Running the code in the sandbox....') + const execution = await sbx.runCode(aiGeneratedCode) + console.log('Code execution finished!') + console.log(execution) +} +``` +```python main.py +# ... code from the previous step + +def run_ai_generated_code(ai_generated_code: str): + print('Running the code in the sandbox....') + execution = sbx.run_code(ai_generated_code) + print('Code execution finished!') + print(execution) +``` + + +### 6. Prepare the prompt and initialize Anthropic client +The prompt we'll be using describes the dataset and the analysis we want to perform like this: + 1. Describe the columns in the CSV dataset. + 2. Ask the LLM what we want to analyze - here we want to analyze the vote average over time. We're asking for a chart as the output. + 3. Instruct the LLM to generate Python code for the data analysis. + + +```js index.ts +import Anthropic from '@anthropic-ai/sdk' + +const prompt = ` +I have a CSV file about movies. It has about 10k rows. It's saved in the sandbox at ${dataset_path_in_sandbox.path}. +These are the columns: +- 'id': number, id of the movie +- 'original_language': string like "eng", "es", "ko", etc +- 'original_title': string that's name of the movie in the original language +- 'overview': string about the movie +- 'popularity': float, from 0 to 9137.939. It's not normalized at all and there are outliers +- 'release_date': date in the format yyyy-mm-dd +- 'title': string that's the name of the movie in english +- 'vote_average': float number between 0 and 10 that's representing viewers voting average +- 'vote_count': int for how many viewers voted + +I want to better understand how the vote average has changed over the years. Write Python code that analyzes the dataset based on my request and produces right chart accordingly` + +const anthropic = new Anthropic() +console.log('Waiting for the model response...') +const msg = await anthropic.messages.create({ + model: 'claude-3-5-sonnet-20240620', + max_tokens: 1024, + messages: [{ role: 'user', content: prompt }], +}) +``` + +```python main.py +from anthropic import Anthropic + +prompt = ''' +I have a CSV file about movies. It has about 10k rows. It's saved in the sandbox at {datasetPathInSandbox.path}. +These are the columns: +- 'id': number, id of the movie +- 'original_language': string like "eng", "es", "ko", etc +- 'original_title': string that's name of the movie in the original language +- 'overview': string about the movie +- 'popularity': float, from 0 to 9137.939. It's not normalized at all and there are outliers +- 'release_date': date in the format yyyy-mm-dd +- 'title': string that's the name of the movie in english +- 'vote_average': float number between 0 and 10 that's representing viewers voting average +- 'vote_count': int for how many viewers voted + +I want to better understand how the vote average has changed over the years. Write Python code that analyzes the dataset based on my request and produces right chart accordingly''' + +anthropic = Anthropic() +msg = anthropic.messages.create( + model='claude-3-5-sonnet-20240620', + max_tokens=1024, + messages=[ + {"role": "user", "content": prompt} + ] +) +``` + + +### 7. Connect the sandbox to the LLM with tool calling +We'll use Claude's ability to [use tools (function calling)](https://docs.anthropic.com/en/docs/build-with-claude/tool-use) to run the code in the sandbox. + +The way we'll do it is by connecting the method for running AI-generated code we created in the previous step to the Claude model. + +Update the initialization of the Anthropic client to include the tool use like this: + +```js index.ts +const msg = await anthropic.messages.create({ + model: 'claude-3-5-sonnet-20240620', + max_tokens: 1024, + messages: [{ role: 'user', content: prompt }], + tools: [ // $HighlightLine + { // $HighlightLine + name: 'run_python_code', // $HighlightLine + description: 'Run Python code', // $HighlightLine + input_schema: { // $HighlightLine + type: 'object', // $HighlightLine + properties: { // $HighlightLine + code: { // $HighlightLine + type: 'string', // $HighlightLine + description: 'The Python code to run', // $HighlightLine + }, // $HighlightLine + }, // $HighlightLine + required: ['code'], // $HighlightLine + }, // $HighlightLine + }, // $HighlightLine + ], // $HighlightLine +}) +``` +```python main.py +msg = anthropic.messages.create( + model='claude-3-5-sonnet-20240620', + max_tokens=1024, + messages=[ + {"role": "user", "content": prompt} + ], + tools=[ # $HighlightLine + { # $HighlightLine + "name": "run_python_code", # $HighlightLine + "description": "Run Python code", # $HighlightLine + "input_schema": { # $HighlightLine + "type": "object", # $HighlightLine + "properties": { # $HighlightLine + "code": { "type": "string", "description": "The Python code to run" }, # $HighlightLine + }, # $HighlightLine + "required": ["code"], # $HighlightLine + }, # $HighlightLine + }, # $HighlightLine + ], # $HighlightLine +) +``` + + +### 8. Parse the LLM response and run the AI-generated code in the sandbox +Now we'll parse the `msg` object to get the code from the LLM's response based on the tool we created in the previous step. +Once we have the code, we'll pass it to the `runAIGeneratedCode` method in JavaScript or `run_ai_generated_code` method in Python we created in the previous step to run the code in the sandbox. + + +```js index.ts +// ... code from the previous steps + +interface CodeRunToolInput { + code: string +} + +for (const contentBlock of msg.content) { + if (contentBlock.type === 'tool_use') { + if (contentBlock.name === 'run_python_code') { + const code = (contentBlock.input as CodeRunToolInput).code + console.log('Will run following code in the sandbox', code) + // Execute the code in the sandbox + await runAIGeneratedCode(code) + } + } +} +``` +```python main.py +for content_block in msg.content: + if content_block.type == 'tool_use': + if content_block.name == 'run_python_code': + code = content_block.input['code'] + print('Will run following code in the sandbox', code) + # Execute the code in the sandbox + run_ai_generated_code(code) +``` + + +### 9. Save the generated chart +When running code in the sandbox for data analysis, you can get different types of results. +Including stdout, stderr, charts, tables, text, runtime errors, and more. + +In this example we're specifically asking for a chart so we'll be looking for the chart in the results. + +Let's update the `runAIGeneratedCode` method in JavaScript and `run_ai_generated_code` method in Python to check for the chart in the results and save it to the file. + +```js index.ts +async function runAIGeneratedCode(aiGeneratedCode: string) { + console.log('Running the code in the sandbox....') + const execution = await sbx.runCode(aiGeneratedCode) + console.log('Code execution finished!') + + // First let's check if the code ran successfully. + if (execution.error) { // $HighlightLine + console.error('AI-generated code had an error.') // $HighlightLine + console.log(execution.error.name) // $HighlightLine + console.log(execution.error.value) // $HighlightLine + console.log(execution.error.traceback) // $HighlightLine + process.exit(1) // $HighlightLine + } // $HighlightLine + + // Iterate over all the results and specifically check for png files that will represent the chart. + let resultIdx = 0 // $HighlightLine + for (const result of execution.results) { // $HighlightLine + if (result.png) { // $HighlightLine + // Save the png to a file + // The png is in base64 format. + fs.writeFileSync(`chart-${resultIdx}.png`, result.png, { encoding: 'base64' }) // $HighlightLine + console.log(`Chart saved to chart-${resultIdx}.png`) // $HighlightLine + resultIdx++ // $HighlightLine + } // $HighlightLine + } // $HighlightLine +} +``` +```python main.py +def run_ai_generated_code(ai_generated_code: str): + print('Running the code in the sandbox....') + execution = sbx.run_code(ai_generated_code) + print('Code execution finished!') + + # First let's check if the code ran successfully. + if execution.error: # $HighlightLine + print('AI-generated code had an error.') # $HighlightLine + print(execution.error.name) # $HighlightLine + print(execution.error.value) # $HighlightLine + print(execution.error.traceback) # $HighlightLine + sys.exit(1) # $HighlightLine + + # Iterate over all the results and specifically check for png files that will represent the chart. + result_idx = 0 # $HighlightLine + for result in execution.results: # $HighlightLine + if result.png: # $HighlightLine + # Save the png to a file + # The png is in base64 format. + with open(f'chart-{result_idx}.png', 'wb') as f: # $HighlightLine + f.write(base64.b64decode(result.png)) # $HighlightLine + print(f'Chart saved to chart-{result_idx}.png') # $HighlightLine + result_idx += 1 # $HighlightLine +``` + + +### 10. Run the code +Now you can run the whole code to see the results. + + +```bash JavaScript & TypeScript +npx tsx index.ts +``` +```bash Python +python main.py +``` + + +You should see the chart in the root of your project that will look similar to this: + + + + + +### Full final code +Check the full code in JavaScript and Python below: + +```js index.ts +import 'dotenv/config' +import fs from 'fs' +import Anthropic from '@anthropic-ai/sdk' +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox +const sbx = await Sandbox.create() + +// Upload the dataset to the sandbox +const content = fs.readFileSync('dataset.csv') +const datasetPathInSandbox = await sbx.files.write('/home/user/dataset.csv', content) + +async function runAIGeneratedCode(aiGeneratedCode: string) { + const execution = await sbx.runCode(aiGeneratedCode) + if (execution.error) { + console.error('AI-generated code had an error.') + console.log(execution.error.name) + console.log(execution.error.value) + console.log(execution.error.traceback) + process.exit(1) + } + // Iterate over all the results and specifically check for png files that will represent the chart. + let resultIdx = 0 + for (const result of execution.results) { + if (result.png) { + // Save the png to a file + // The png is in base64 format. + fs.writeFileSync(`chart-${resultIdx}.png`, result.png, { encoding: 'base64' }) + console.log('Chart saved to chart-${resultIdx}.png') + resultIdx++ + } + } +} + +const prompt = ` +I have a CSV file about movies. It has about 10k rows. It's saved in the sandbox at ${datasetPathInSandbox.path}. +These are the columns: +- 'id': number, id of the movie +- 'original_language': string like "eng", "es", "ko", etc +- 'original_title': string that's name of the movie in the original language +- 'overview': string about the movie +- 'popularity': float, from 0 to 9137.939. It's not normalized at all and there are outliers +- 'release_date': date in the format yyyy-mm-dd +- 'title': string that's the name of the movie in english +- 'vote_average': float number between 0 and 10 that's representing viewers voting average +- 'vote_count': int for how many viewers voted + +I want to better understand how the vote average has changed over the years. Write Python code that analyzes the dataset based on my request and produces right chart accordingly` + +const anthropic = new Anthropic() +console.log('Waiting for the model response...') +const msg = await anthropic.messages.create({ + model: 'claude-3-5-sonnet-20240620', + max_tokens: 1024, + messages: [{ role: 'user', content: prompt }], + tools: [ + { + name: 'run_python_code', + description: 'Run Python code', + input_schema: { + type: 'object', + properties: { + code: { + type: 'string', + description: 'The Python code to run', + }, + }, + required: ['code'], + }, + }, + ], +}) + +interface CodeRunToolInput { + code: string +} + +for (const contentBlock of msg.content) { + if (contentBlock.type === 'tool_use') { + if (contentBlock.name === 'run_python_code') { + const code = (contentBlock.input as CodeRunToolInput).code + console.log('Will run following code in the sandbox', code) + // Execute the code in the sandbox + await runAIGeneratedCode(code) + } + } +} +``` +```python main.py +import sys +import base64 +from dotenv import load_dotenv +load_dotenv() +from e2b_code_interpreter import Sandbox +from anthropic import Anthropic + +# Create sandbox +sbx = Sandbox.create() + +# Upload the dataset to the sandbox +with open("../dataset.csv", "rb") as f: + dataset_path_in_sandbox = sbx.files.write("dataset.csv", f) + + +def run_ai_generated_code(ai_generated_code: str): + print('Running the code in the sandbox....') + execution = sbx.run_code(ai_generated_code) + print('Code execution finished!') + + # First let's check if the code ran successfully. + if execution.error: + print('AI-generated code had an error.') + print(execution.error.name) + print(execution.error.value) + print(execution.error.traceback) + sys.exit(1) + + # Iterate over all the results and specifically check for png files that will represent the chart. + result_idx = 0 + for result in execution.results: + if result.png: + # Save the png to a file + # The png is in base64 format. + with open(f'chart-{result_idx}.png', 'wb') as f: + f.write(base64.b64decode(result.png)) + print(f'Chart saved to chart-{result_idx}.png') + result_idx += 1 + +prompt = f""" +I have a CSV file about movies. It has about 10k rows. It's saved in the sandbox at {dataset_path_in_sandbox.path}. +These are the columns: +- 'id': number, id of the movie +- 'original_language': string like "eng", "es", "ko", etc +- 'original_title': string that's name of the movie in the original language +- 'overview': string about the movie +- 'popularity': float, from 0 to 9137.939. It's not normalized at all and there are outliers +- 'release_date': date in the format yyyy-mm-dd +- 'title': string that's the name of the movie in english +- 'vote_average': float number between 0 and 10 that's representing viewers voting average +- 'vote_count': int for how many viewers voted + +I want to better understand how the vote average has changed over the years. +Write Python code that analyzes the dataset based on my request and produces right chart accordingly""" + +anthropic = Anthropic() +print("Waiting for model response...") +msg = anthropic.messages.create( + model='claude-3-5-sonnet-20240620', + max_tokens=1024, + messages=[ + {"role": "user", "content": prompt} + ], + tools=[ + { + "name": "run_python_code", + "description": "Run Python code", + "input_schema": { + "type": "object", + "properties": { + "code": { "type": "string", "description": "The Python code to run" }, + }, + "required": ["code"] + } + } + ] +) + +for content_block in msg.content: + if content_block.type == "tool_use": + if content_block.name == "run_python_code": + code = content_block.input["code"] + print("Will run following code in the sandbox", code) + # Execute the code in the sandbox + run_ai_generated_code(code) + +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries/index.mdx new file mode 100644 index 0000000000..2629651380 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries/index.mdx @@ -0,0 +1,36 @@ +--- +title: "Pre-installed libraries" +--- + +The sandbox comes with a [set of pre-installed Python libraries](https://github.com/e2b-dev/code-interpreter/blob/main/template/requirements.txt) for data analysis +but you can [install additional packages](/quickstart/install-custom-packages): +- `aiohttp` (v3.9.3) +- `beautifulsoup4` (v4.12.3) +- `bokeh` (v3.3.4) +- `gensim` (v4.3.2) +- `imageio` (v2.34.0) +- `joblib` (v1.3.2) +- `librosa` (v0.10.1) +- `matplotlib` (v3.8.3) +- `nltk` (v3.8.1) +- `numpy` (v1.26.4) +- `opencv-python` (v4.9.0.80) +- `openpyxl` (v3.1.2) +- `pandas` (v1.5.3) +- `plotly` (v5.19.0) +- `pytest` (v8.1.0) +- `python`-docx (v1.1.0) +- `pytz` (v2024.1) +- `requests` (v2.26.0) +- `scikit-image` (v0.22.0) +- `scikit-learn` (v1.4.1.post1) +- `scipy` (v1.12.0) +- `seaborn` (v0.13.2) +- `soundfile` (v0.12.1) +- `spacy` (v3.7.4) +- `textblob` (v0.18.0) +- `tornado` (v6.4) +- `urllib3` (v1.26.7) +- `xarray` (v2024.2.0) +- `xlrd` (v2.0.1) +- `sympy` (v1.12) diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/index.mdx new file mode 100644 index 0000000000..e18f863e64 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/index.mdx @@ -0,0 +1,13 @@ +--- +sidebarTitle: Overview +title: "Create charts & visualizations" +--- + +E2B Sandbox allows you to create charts and visualizations by executing Python code inside the sandbox with `runCode()` method in JavaScript and `run_code()` method in Python. + +These charts and visualizations can be [static](/code-interpreting/create-charts-visualizations/static-charts) or [interactive](/code-interpreting/create-charts-visualizations/interactive-charts) plots. + +{/* +Learn more about different types of results that E2B Sandbox can return [(TODO: link)here](/code-interpreting/results). + */} + diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/interactive-charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/interactive-charts/index.mdx new file mode 100644 index 0000000000..32b63eadb1 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/interactive-charts/index.mdx @@ -0,0 +1,177 @@ +--- +title: "Interactive charts" +--- + +E2B also allows you to create interactive charts with custom styling. + +E2B automatically detects charts when executing Python code with `runCode()` in JavaScript or `run_code()` in Python. The Python code must include Matplotlib charts. + +When a chart is detected, E2B sends the data of the chart back to the client. You can access the chart in the `execution.results` array where each item is a `Result` object with the `chart` property. + + +Try out [AI Data Analyst](https://github.com/e2b-dev/ai-analyst/) - a Next.js app that uses E2B to create interactive charts. + + +Here's a simple example of bar chart: + +```js JavaScript & TypeScript +import { Sandbox, BarChart } from '@e2b/code-interpreter' + +const code = ` +import matplotlib.pyplot as plt + +# Prepare data +authors = ['Author A', 'Author B', 'Author C', 'Author D'] +sales = [100, 200, 300, 400] + +# Create and customize the bar chart +plt.figure(figsize=(10, 6)) +plt.bar(authors, sales, label='Books Sold', color='blue') +plt.xlabel('Authors') +plt.ylabel('Number of Books Sold') +plt.title('Book Sales by Authors') + +# Display the chart +plt.tight_layout() +plt.show() +` + +const sandbox = await Sandbox.create() +const result = await sandbox.runCode(code) +const chart = result.results[0].chart as BarChart + +console.log('Type:', chart.type) +console.log('Title:', chart.title) +console.log('X Label:', chart.x_label) +console.log('Y Label:', chart.y_label) +console.log('X Unit:', chart.x_unit) +console.log('Y Unit:', chart.y_unit) +console.log('Elements:', chart.elements) +``` +```python Python +from e2b_code_interpreter import Sandbox + +code = """ +import matplotlib.pyplot as plt + +# Prepare data +authors = ['Author A', 'Author B', 'Author C', 'Author D'] +sales = [100, 200, 300, 400] + +# Create and customize the bar char +plt.figure(figsize=(10, 6)) +plt.bar(authors, sales, label='Books Sold', color='blue') +plt.xlabel('Authors') +plt.ylabel('Number of Books Sold') +plt.title('Book Sales by Authors') + +# Display the chart +plt.tight_layout() +plt.show() +""" + +sandbox = Sandbox.create() +execution = sandbox.run_code(code) +chart = execution.results[0].chart + +print('Type:', chart.type) +print('Title:', chart.title) +print('X Label:', chart.x_label) +print('Y Label:', chart.y_label) +print('X Unit:', chart.x_unit) +print('Y Unit:', chart.y_unit) +print('Elements:') +for element in chart.elements: + print('\n Label:', element.label) + print(' Value:', element.value) + print(' Group:', element.group) +``` + + + +The code above will output the following: + +```bash JavaScript & TypeScript +Type: bar +Title: Book Sales by Authors +X Label: Authors +Y Label: Number of Books Sold +X Unit: null +Y Unit: null +Elements: [ + { + label: "Author A", + group: "Books Sold", + value: 100, + }, { + label: "Author B", + group: "Books Sold", + value: 200, + }, { + label: "Author C", + group: "Books Sold", + value: 300, + }, { + label: "Author D", + group: "Books Sold", + value: 400, + } +] +``` +```bash Python +Type: ChartType.BAR +Title: Book Sales by Authors +X Label: Authors +Y Label: Number of Books Sold +X Unit: None +Y Unit: None +Elements: + + Label: Author A + Value: 100.0 + Group: Books Sold + + Label: Author B + Value: 200.0 + Group: Books Sold + + Label: Author C + Value: 300.0 + Group: Books Sold + + Label: Author D + Value: 400.0 + Group: Books Sold +``` + + +You can send this data to your frontend to create an interactive chart with your favorite charting library. + +--- + +## Supported intertactive charts +The following charts are currently supported: +- Line chart +- Bar chart +- Scatter plot +- Pie chart +- Box and whisker plot + + +{/* The following charts are currently supported: +- [Line chart](#line-chart) +- [Bar chart](#bar-chart) +- [Scatter plot](#scatter-plot) +- [Pie chart](#pie-chart) +- [Box and whisker plot](#box-and-whisker-plot) + + +## Line chart + +## Bar chart + +## Scatter plot + +## Pie chart + +## Box and whisker plot */} \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/static-charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/static-charts/index.mdx new file mode 100644 index 0000000000..2a7d33710e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/create-charts-visualizations/static-charts/index.mdx @@ -0,0 +1,68 @@ +--- +title: "Static charts" +--- + +Every time you run Python code with `runCode()` in JavaScript or `run_code()` method in Python, the code is executed in a headless Jupyter server inside the sandbox. + +E2B automatically detects any plots created with Matplotlib and sends them back to the client as images encoded in the base64 format. +These images are directly accesible on the `result` items in the `execution.results` array. + +Here's how to retrieve a static chart from the executed Python code that contains a Matplotlib plot. + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' +import fs from 'fs' + +const codeToRun = ` +import matplotlib.pyplot as plt + +plt.plot([1, 2, 3, 4]) +plt.ylabel('some numbers') +plt.show() +` +const sandbox = await Sandbox.create() + +// Run the code inside the sandbox +const execution = await sandbox.runCode(codeToRun) + + // There's only one result in this case - the plot displayed with `plt.show()` +const firstResult = execution.results[0] + +if (firstResult.png) { + // Save the png to a file. The png is in base64 format. + fs.writeFileSync('chart.png', firstResult.png, { encoding: 'base64' }) + console.log('Chart saved as chart.png') +} +``` +```python Python +import base64 +from e2b_code_interpreter import Sandbox + +code_to_run = """ +import matplotlib.pyplot as plt + +plt.plot([1, 2, 3, 4]) +plt.ylabel('some numbers') +plt.show() +""" + +sandbox = Sandbox.create() + +# Run the code inside the sandbox +execution = sandbox.run_code(code_to_run) + +# There's only one result in this case - the plot displayed with `plt.show()` +first_result = execution.results[0] + +if first_result.png: + # Save the png to a file. The png is in base64 format. + with open('chart.png', 'wb') as f: + f.write(base64.b64decode(first_result.png)) + print('Chart saved as chart.png') +``` + + +The code in the variable `codeToRun`/`code_to_run` will produce this following plot that we're saving as `chart.png` file. + + + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx new file mode 100644 index 0000000000..a426246df0 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx @@ -0,0 +1,142 @@ +--- +title: "Streaming" +--- + +Use E2B SDK allows you to stream the output, and results when executing code in the sandbox. + + +## Stream `stdout` and `stderr` +When using the `runCode()` method in JavaScript or `run_code()` in Python you can pass `onStdout`/`on_stdout` and `onStderr`/`on_stderr` callbacks to handle the output. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const codeToRun = ` + import time + import sys + print("This goes first to stdout") + time.sleep(3) + print("This goes later to stderr", file=sys.stderr) + time.sleep(3) + print("This goes last") +` +const sandbox = await Sandbox.create() +sandbox.runCode(codeToRun, { + // Use `onError` to handle runtime code errors + onError: error => console.error('error:', error), // $HighlightLine + onStdout: data => console.log('stdout:', data), // $HighlightLine + onStderr: data => console.error('stderr:', data), // $HighlightLine +}) +``` +```python Python +from e2b_code_interpreter import Sandbox + +code_to_run = """ + import time + import sys + print("This goes first to stdout") + time.sleep(3) + print("This goes later to stderr", file=sys.stderr) + time.sleep(3) + print("This goes last") +""" + +sandbox = Sandbox.create() +sandbox.run_code( + code_to_run, + # Use `on_error` to handle runtime code errors + on_error=lambda error: print('error:', error), # $HighlightLine + on_stdout=lambda data: print('stdout:', data), # $HighlightLine + on_stderr=lambda data: print('stderr:', data), # $HighlightLine +) +``` + + +The code above will print the following: + + +```javascript JavaScript & TypeScript +stdout: { + error: false, + line: "This goes first to stdout\n", + timestamp: 1729049666861000, +} +stderr: { + error: true, + line: "This goes later to stderr\n", + timestamp: 1729049669924000, +} +stdout: { + error: false, + line: "This goes last\n", + timestamp: 1729049672664000, +} +``` +```bash Python +stdout: This goes first to stdout + +stderr: This goes later to stderr + +stdout: This goes last + +``` + + +## Stream `results` + +When using the `runCode()` method in JavaScript or `run_code()` in Python you can pass `onResults`/`on_results` callback +to receive results from the sandbox like charts, tables, text, and more. + + +```js JavaScript & TypeScript +const codeToRun = ` +import matplotlib.pyplot as plt + +# Prepare data +categories = ['Category A', 'Category B', 'Category C', 'Category D'] +values = [10, 20, 15, 25] + +# Create and customize the bar chart +plt.figure(figsize=(10, 6)) +plt.bar(categories, values, color='green') +plt.xlabel('Categories') +plt.ylabel('Values') +plt.title('Values by Category') + +# Display the chart +plt.show() +` +const sandbox = await Sandbox.create() +await sandbox.runCode(codeToRun, { + onResult: result => console.log('result:', result), // $HighlightLine +}) +``` +```python Python +from e2b_code_interpreter import Sandbox + +code_to_run = """ +import matplotlib.pyplot as plt + +# Prepare data +categories = ['Category A', 'Category B', 'Category C', 'Category D'] +values = [10, 20, 15, 25] + +# Create and customize the bar chart +plt.figure(figsize=(10, 6)) +plt.bar(categories, values, color='green') +plt.xlabel('Categories') +plt.ylabel('Values') +plt.title('Values by Category') + +# Display the chart +plt.show() +""" + +sandbox = Sandbox.create() +sandbox.run_code( + code_to_run, + on_result=lambda result: print('result:', result), # $HighlightLine +) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/bash/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/bash/index.mdx new file mode 100644 index 0000000000..323e7e4911 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/bash/index.mdx @@ -0,0 +1,23 @@ +--- +sidebarTitle: Bash +title: "Run bash code" +--- + +Use the `runCode`/`run_code` method to run bash code inside the sandbox. +You'll need to pass the `language` parameter with value `bash`. + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +const execution = await sbx.runCode('echo "Hello, world!"', { language: 'bash' }) +console.log(execution) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +execution = sbx.run_code("echo 'Hello, world!'", language="bash") +print(execution) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/index.mdx new file mode 100644 index 0000000000..e9cfc0a690 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/index.mdx @@ -0,0 +1,17 @@ +--- +sidebarTitle: Overview +title: "Supported languages" +--- + +Typically you use Python to run AI-generated code for data analysis but you can use other languages as well. + +Out of the box E2B Sandbox supports: +- [Python](/code-interpreting/supported-languages/python) +- [JavaScript and TypeScript](/code-interpreting/supported-languages/javascript) +- [R](/code-interpreting/supported-languages/r) +- [Java](/code-interpreting/supported-languages/java) +- [Bash](/code-interpreting/supported-languages/bash) + + +You can use any custom language runtime by creating a [custom sandbox template](/sandbox-template). + diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/java/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/java/index.mdx new file mode 100644 index 0000000000..f6cba19052 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/java/index.mdx @@ -0,0 +1,23 @@ +--- +title: "Run Java code" +sidebarTitle: Java +--- + +Use the `runCode`/`run_code` method to run Java code inside the sandbox. +You'll need to pass the `language` parameter with value `java`. + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +const execution = await sbx.runCode('System.out.println("Hello, world!");', { language: 'java' }) +console.log(execution) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +execution = sbx.run_code('System.out.println("Hello, world!");', language="java") +print(execution) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/javascript/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/javascript/index.mdx new file mode 100644 index 0000000000..51d7cf9a86 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/javascript/index.mdx @@ -0,0 +1,78 @@ +--- +title: "Run JavaScript and TypeScript code" +sidebarTitle: "JavaScript and TypeScript" +--- + +Use the `runCode`/`run_code` method to run JavaScript and TypeScript code inside the sandbox. +You'll need to pass the `language` parameter with value `javascript` or `js` for JavaScript and `typescript` or `ts` for TypeScript. + + +The E2B Code Interpreter supports TypeScript, top-level await, ESM-style imports and automatic promises resolution. + + + +```js JavaScript & TypeScript +import { Sandbox } from "@e2b/code-interpreter"; + +// Create a new sandbox +const sbx = await Sandbox.create(); + +// Install the axios package +await sbx.commands.run("npm install axios"); + +// Run the code +const execution = await sbx.runCode(` + import axios from "axios"; + + const url: string = "https://api.github.com/status"; + const response = await axios.get(url); + response.data; +`, + { language: "ts" } +); + +console.log(execution); + +// Execution { +// results: [], +// logs: { +// stdout: [ "{ message: 'GitHub lives! (2025-05-28 10:49:55 -0700) (1)' }\n" ], +// stderr: [], +// }, +// error: undefined, +// executionCount: 1, +// text: [Getter], +// toJSON: [Function: toJSON], +// } +``` +```python Python +from e2b_code_interpreter import Sandbox + +# Create a new sandbox +sbx = Sandbox.create() + +# Install the axios package +sbx.commands.run("npm install axios") + +# Run the code +execution = sbx.run_code(""" + import axios from "axios"; + + const url: string = "https://api.github.com/status"; + const response = await axios.get(url); + response.data; +""", + language="ts", +) + +print(execution) + +# Execution( +# Results: [ +# Result({ message: 'GitHub lives! (2025-05-28 10:48:47 -0700) (1)' }) +# ], +# Logs: Logs(stdout: [], stderr: []), +# Error: None +# ) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/python/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/python/index.mdx new file mode 100644 index 0000000000..306e4692bd --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/python/index.mdx @@ -0,0 +1,22 @@ +--- +sidebarTitle: Python +title: "Run Python code" +--- + +Use the `runCode`/`run_code` method to run Python code inside the sandbox. + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +const execution = await sbx.runCode('print("Hello, world!")') +console.log(execution) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +execution = sbx.run_code('print("Hello, world!")') +print(execution) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/r/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/r/index.mdx new file mode 100644 index 0000000000..a849eab7a7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/supported-languages/r/index.mdx @@ -0,0 +1,24 @@ +--- +title: Run R code +sidebarTitle: R +--- + + +Use the `runCode`/`run_code` method to run R code inside the sandbox. +You'll need to pass the `language` parameter with value `r`. + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +const execution = await sbx.runCode('print("Hello, world!")', { language: 'r' }) +console.log(execution) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +execution = sbx.run_code('print("Hello, world!")', language="r") +print(execution) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx new file mode 100644 index 0000000000..857ea91337 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx @@ -0,0 +1,45 @@ +--- +title: "Running commands in background" +sidebarTitle: Run commands in background +--- + +To run commands in background, pass the `background` option to the `commands.run()` method. This will return immediately and the command will continue to run in the sandbox. +You can then later kill the command using the `commands.kill()` method. + + +```js JavaScript & TypeScript highlight={7} +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// Start the command in the background +const command = await sandbox.commands.run('echo hello; sleep 10; echo world', { + background: true, // $HighlightLine + onStdout: (data) => { + console.log(data) + }, +}) + +// Kill the command +await command.kill() +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Start the command in the background +command = sandbox.commands.run('echo hello; sleep 10; echo world', background=True) + +# Get stdout and stderr from the command running in the background. +# You can run this code in a separate thread or use command.wait() to wait for the command to finish. +for stdout, stderr, _ in command: + if stdout: + print(stdout) + if stderr: + print(stderr) + +# Kill the command +command.kill() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/commands/index.mdx new file mode 100644 index 0000000000..e8a43516cd --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/commands/index.mdx @@ -0,0 +1,24 @@ +--- +title: "Running commands in sandbox" +sidebarTitle: Overview +--- + +You can run terminal commands inside the sandbox using the `commands.run()` method. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +const result = await sandbox.commands.run('ls -l') +console.log(result) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +result = sandbox.commands.run('ls -l') +print(result) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/commands/streaming/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/commands/streaming/index.mdx new file mode 100644 index 0000000000..2fc08ab693 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/commands/streaming/index.mdx @@ -0,0 +1,32 @@ +--- +title: "Streaming command output" +sidebarTitle: Streaming +--- + +To stream command output as it is being executed, pass the `onStdout`, `onStderr` callbacks to the `commands.run()` method in JavaScript +or the `on_stdout`, `on_stderr` callbacks to the `commands.run()` method in Python. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +const result = await sandbox.commands.run('echo hello; sleep 1; echo world', { + onStdout: (data) => { + console.log(data) + }, + onStderr: (data) => { + console.log(data) + }, +}) +console.log(result) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +result = sandbox.commands.run('echo hello; sleep 1; echo world', on_stdout=lambda data: print(data), on_stderr=lambda data: print(data)) +print(result) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/cookbook/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/cookbook/index.mdx new file mode 100644 index 0000000000..af85244002 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/cookbook/index.mdx @@ -0,0 +1,5 @@ +--- +url: https://github.com/e2b-dev/e2b-cookbook +title: Cookbook +icon: "brackets-curly" +--- \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/docs.json b/apps/web/src/app/(docs)/mintlify-docs/docs.json new file mode 100644 index 0000000000..afe812021b --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/docs.json @@ -0,0 +1,2612 @@ +{ + "$schema": "https://mintlify.com/docs.json", + "theme": "maple", + "name": "E2B Docs", + "colors": { + "primary": "#ff8800", + "light": "#ff8800", + "dark": "#ffffff" + }, + "favicon": "/favicon.jpeg", + "navigation": { + "anchors": [ + { + "anchor": "Documentation", + "icon": "book-open-cover", + "groups": [ + { + "group": "Getting Started", + "pages": [ + "index", + { + "group": "Quickstart", + "icon": "circle-check", + "pages": [ + "quickstart/index", + "quickstart/connect-llms/index", + "quickstart/upload-download-files/index", + "quickstart/install-custom-packages/index" + ] + }, + "api-key/index", + "cookbook/index", + "support/index" + ] + }, + { + "group": "Code Interpreting", + "pages": [ + { + "group": "Analyze data with AI", + "pages": [ + "code-interpreting/analyze-data-with-ai/index", + "code-interpreting/analyze-data-with-ai/pre-installed-libraries/index" + ] + }, + { + "group": "Charts & visualizations", + "pages": [ + "code-interpreting/create-charts-visualizations/index", + "code-interpreting/create-charts-visualizations/static-charts/index", + "code-interpreting/create-charts-visualizations/interactive-charts/index" + ] + }, + "code-interpreting/streaming/index", + { + "group": "Supported languages", + "pages": [ + "code-interpreting/supported-languages/index", + "code-interpreting/supported-languages/python/index", + "code-interpreting/supported-languages/javascript/index", + "code-interpreting/supported-languages/r/index", + "code-interpreting/supported-languages/java/index", + "code-interpreting/supported-languages/bash/index" + ] + } + ] + }, + { + "group": "Sandbox", + "pages": [ + "sandbox/index", + "sandbox/lifecycle-events-api/index", + "sandbox/lifecycle-events-webhooks/index", + "sandbox/persistence/index", + "sandbox/metrics/index", + "sandbox/metadata/index", + "sandbox/environment-variables/index", + "sandbox/list/index", + "sandbox/connect/index", + "sandbox/internet-access/index", + "sandbox/connect-bucket/index", + "sandbox/rate-limits/index" + ] + }, + { + "group": "Templates", + "pages": [ + "sandbox-template/index", + "sandbox-template/start-cmd/index", + "sandbox-template/ready-cmd/index", + "sandbox-template/customize-cpu-ram/index" + ] + }, + { + "group": "Filesystem", + "pages": [ + "filesystem/index", + "filesystem/read-write/index", + "filesystem/info/index", + "filesystem/watch/index", + "filesystem/upload/index", + "filesystem/download/index" + ] + }, + { + "group": "Commands", + "pages": [ + "commands/index", + "commands/streaming/index", + "commands/background/index" + ] + }, + { + "group": "CLI", + "pages": [ + "cli/index", + "cli/auth/index", + "cli/list-sandboxes/index", + "cli/shutdown-sandboxes/index" + ] + }, + { + "group": "Deployment", + "pages": [ + "byoc/index" + ] + }, + { + "group": "Migration", + "pages": [ + "migration/v2/index" + ] + }, + { + "group": "Troubleshooting", + "pages": [ + { + "group": "SDKs", + "pages": [ + "troubleshooting/sdks/workers-edge-runtime/index" + ] + }, + { + "group": "Templates", + "pages": [ + "troubleshooting/templates/build-authentication-error/index" + ] + } + ] + } + ] + }, + { + "anchor": "SDK Reference", + "icon": "brackets-curly", + "dropdowns": [ + { + "dropdown": "SDK Reference", + "icon": "brackets-curly", + "pages": [ + "sdk-reference/index" + ] + }, + { + "dropdown": "CLI", + "icon": "terminal", + "versions": [ + { + "version": "v2.2.0@latest", + "groups": [ + { + "group": "CLI v2.2.0", + "pages": [ + "sdk-reference/cli/v2.2.0/auth/index", + "sdk-reference/cli/v2.2.0/sandbox/index", + "sdk-reference/cli/v2.2.0/template/index" + ] + } + ] + }, + { + "version": "v2.1.0", + "groups": [ + { + "group": "CLI v2.1.0", + "pages": [ + "sdk-reference/cli/v2.1.0/auth/index", + "sdk-reference/cli/v2.1.0/sandbox/index", + "sdk-reference/cli/v2.1.0/template/index" + ] + } + ] + }, + { + "version": "v2.0.3", + "groups": [ + { + "group": "CLI v2.0.3", + "pages": [ + "sdk-reference/cli/v2.0.3/auth/index", + "sdk-reference/cli/v2.0.3/sandbox/index", + "sdk-reference/cli/v2.0.3/template/index" + ] + } + ] + }, + { + "version": "v2.0.2", + "groups": [ + { + "group": "CLI v2.0.2", + "pages": [ + "sdk-reference/cli/v2.0.2/auth/index", + "sdk-reference/cli/v2.0.2/sandbox/index", + "sdk-reference/cli/v2.0.2/template/index" + ] + } + ] + }, + { + "version": "v2.0.1", + "groups": [ + { + "group": "CLI v2.0.1", + "pages": [ + "sdk-reference/cli/v2.0.1/auth/index", + "sdk-reference/cli/v2.0.1/sandbox/index", + "sdk-reference/cli/v2.0.1/template/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "CLI v2.0.0", + "pages": [ + "sdk-reference/cli/v2.0.0/auth/index", + "sdk-reference/cli/v2.0.0/sandbox/index", + "sdk-reference/cli/v2.0.0/template/index" + ] + } + ] + }, + { + "version": "v1.9.2", + "groups": [ + { + "group": "CLI v1.9.2", + "pages": [ + "sdk-reference/cli/v1.9.2/auth/index", + "sdk-reference/cli/v1.9.2/sandbox/index", + "sdk-reference/cli/v1.9.2/template/index" + ] + } + ] + }, + { + "version": "v1.9.1", + "groups": [ + { + "group": "CLI v1.9.1", + "pages": [ + "sdk-reference/cli/v1.9.1/auth/index", + "sdk-reference/cli/v1.9.1/sandbox/index", + "sdk-reference/cli/v1.9.1/template/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "CLI v1.9.0", + "pages": [ + "sdk-reference/cli/v1.9.0/auth/index", + "sdk-reference/cli/v1.9.0/sandbox/index", + "sdk-reference/cli/v1.9.0/template/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "CLI v1.8.0", + "pages": [ + "sdk-reference/cli/v1.8.0/auth/index", + "sdk-reference/cli/v1.8.0/sandbox/index", + "sdk-reference/cli/v1.8.0/template/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "CLI v1.7.0", + "pages": [ + "sdk-reference/cli/v1.7.0/auth/index", + "sdk-reference/cli/v1.7.0/sandbox/index", + "sdk-reference/cli/v1.7.0/template/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "CLI v1.6.0", + "pages": [ + "sdk-reference/cli/v1.6.0/auth/index", + "sdk-reference/cli/v1.6.0/sandbox/index", + "sdk-reference/cli/v1.6.0/template/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "CLI v1.5.2", + "pages": [ + "sdk-reference/cli/v1.5.2/auth/index", + "sdk-reference/cli/v1.5.2/sandbox/index", + "sdk-reference/cli/v1.5.2/template/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "CLI v1.5.1", + "pages": [ + "sdk-reference/cli/v1.5.1/auth/index", + "sdk-reference/cli/v1.5.1/sandbox/index", + "sdk-reference/cli/v1.5.1/template/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "CLI v1.5.0", + "pages": [ + "sdk-reference/cli/v1.5.0/auth/index", + "sdk-reference/cli/v1.5.0/sandbox/index", + "sdk-reference/cli/v1.5.0/template/index" + ] + } + ] + }, + { + "version": "v1.4.3", + "groups": [ + { + "group": "CLI v1.4.3", + "pages": [ + "sdk-reference/cli/v1.4.3/auth/index", + "sdk-reference/cli/v1.4.3/sandbox/index", + "sdk-reference/cli/v1.4.3/template/index" + ] + } + ] + }, + { + "version": "v1.4.2", + "groups": [ + { + "group": "CLI v1.4.2", + "pages": [ + "sdk-reference/cli/v1.4.2/auth/index", + "sdk-reference/cli/v1.4.2/sandbox/index", + "sdk-reference/cli/v1.4.2/template/index" + ] + } + ] + }, + { + "version": "v1.4.1", + "groups": [ + { + "group": "CLI v1.4.1", + "pages": [ + "sdk-reference/cli/v1.4.1/auth/index", + "sdk-reference/cli/v1.4.1/sandbox/index", + "sdk-reference/cli/v1.4.1/template/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "CLI v1.4.0", + "pages": [ + "sdk-reference/cli/v1.4.0/auth/index", + "sdk-reference/cli/v1.4.0/sandbox/index", + "sdk-reference/cli/v1.4.0/template/index" + ] + } + ] + }, + { + "version": "v1.3.4", + "groups": [ + { + "group": "CLI v1.3.4", + "pages": [ + "sdk-reference/cli/v1.3.4/auth/index", + "sdk-reference/cli/v1.3.4/sandbox/index", + "sdk-reference/cli/v1.3.4/template/index" + ] + } + ] + }, + { + "version": "v1.3.3", + "groups": [ + { + "group": "CLI v1.3.3", + "pages": [ + "sdk-reference/cli/v1.3.3/auth/index", + "sdk-reference/cli/v1.3.3/sandbox/index", + "sdk-reference/cli/v1.3.3/template/index" + ] + } + ] + }, + { + "version": "v1.3.2", + "groups": [ + { + "group": "CLI v1.3.2", + "pages": [ + "sdk-reference/cli/v1.3.2/auth/index", + "sdk-reference/cli/v1.3.2/sandbox/index", + "sdk-reference/cli/v1.3.2/template/index" + ] + } + ] + }, + { + "version": "v1.3.1", + "groups": [ + { + "group": "CLI v1.3.1", + "pages": [ + "sdk-reference/cli/v1.3.1/auth/index", + "sdk-reference/cli/v1.3.1/sandbox/index", + "sdk-reference/cli/v1.3.1/template/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "CLI v1.3.0", + "pages": [ + "sdk-reference/cli/v1.3.0/auth/index", + "sdk-reference/cli/v1.3.0/sandbox/index", + "sdk-reference/cli/v1.3.0/template/index" + ] + } + ] + }, + { + "version": "v1.2.3", + "groups": [ + { + "group": "CLI v1.2.3", + "pages": [ + "sdk-reference/cli/v1.2.3/auth/index", + "sdk-reference/cli/v1.2.3/sandbox/index", + "sdk-reference/cli/v1.2.3/template/index" + ] + } + ] + }, + { + "version": "v1.2.2", + "groups": [ + { + "group": "CLI v1.2.2", + "pages": [ + "sdk-reference/cli/v1.2.2/auth/index", + "sdk-reference/cli/v1.2.2/sandbox/index", + "sdk-reference/cli/v1.2.2/template/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "CLI v1.2.1", + "pages": [ + "sdk-reference/cli/v1.2.1/auth/index", + "sdk-reference/cli/v1.2.1/sandbox/index", + "sdk-reference/cli/v1.2.1/template/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "CLI v1.2.0", + "pages": [ + "sdk-reference/cli/v1.2.0/auth/index", + "sdk-reference/cli/v1.2.0/sandbox/index", + "sdk-reference/cli/v1.2.0/template/index" + ] + } + ] + }, + { + "version": "v1.0.10", + "groups": [ + { + "group": "CLI v1.0.10", + "pages": [ + "sdk-reference/cli/v1.0.10/auth/index", + "sdk-reference/cli/v1.0.10/sandbox/index", + "sdk-reference/cli/v1.0.10/template/index" + ] + } + ] + }, + { + "version": "v1.0.9", + "groups": [ + { + "group": "CLI v1.0.9", + "pages": [ + "sdk-reference/cli/v1.0.9/auth/index", + "sdk-reference/cli/v1.0.9/sandbox/index", + "sdk-reference/cli/v1.0.9/template/index" + ] + } + ] + }, + { + "version": "v1.0.8", + "groups": [ + { + "group": "CLI v1.0.8", + "pages": [ + "sdk-reference/cli/v1.0.8/auth/index", + "sdk-reference/cli/v1.0.8/sandbox/index", + "sdk-reference/cli/v1.0.8/template/index" + ] + } + ] + }, + { + "version": "v1.0.7", + "groups": [ + { + "group": "CLI v1.0.7", + "pages": [ + "sdk-reference/cli/v1.0.7/auth/index", + "sdk-reference/cli/v1.0.7/sandbox/index", + "sdk-reference/cli/v1.0.7/template/index" + ] + } + ] + }, + { + "version": "v1.0.6", + "groups": [ + { + "group": "CLI v1.0.6", + "pages": [ + "sdk-reference/cli/v1.0.6/auth/index", + "sdk-reference/cli/v1.0.6/sandbox/index", + "sdk-reference/cli/v1.0.6/template/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "CLI v1.0.5", + "pages": [ + "sdk-reference/cli/v1.0.5/auth/index", + "sdk-reference/cli/v1.0.5/sandbox/index", + "sdk-reference/cli/v1.0.5/template/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "CLI v1.0.4", + "pages": [ + "sdk-reference/cli/v1.0.4/auth/index", + "sdk-reference/cli/v1.0.4/sandbox/index", + "sdk-reference/cli/v1.0.4/template/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "CLI v1.0.3", + "pages": [ + "sdk-reference/cli/v1.0.3/auth/index", + "sdk-reference/cli/v1.0.3/sandbox/index", + "sdk-reference/cli/v1.0.3/template/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "CLI v1.0.2", + "pages": [ + "sdk-reference/cli/v1.0.2/auth/index", + "sdk-reference/cli/v1.0.2/sandbox/index", + "sdk-reference/cli/v1.0.2/template/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "CLI v1.0.1", + "pages": [ + "sdk-reference/cli/v1.0.1/auth/index", + "sdk-reference/cli/v1.0.1/sandbox/index", + "sdk-reference/cli/v1.0.1/template/index" + ] + } + ] + }, + { + "version": "v1.0.0", + "groups": [ + { + "group": "CLI v1.0.0", + "pages": [ + "sdk-reference/cli/v1.0.0/auth/index", + "sdk-reference/cli/v1.0.0/sandbox/index", + "sdk-reference/cli/v1.0.0/template/index" + ] + } + ] + } + ] + }, + { + "dropdown": "JavaScript SDK", + "icon": "square-js", + "versions": [ + { + "version": "v2.1.4@latest", + "groups": [ + { + "group": "JavaScript SDK v2.1.4", + "pages": [ + "sdk-reference/js-sdk/v2.1.4/commands/index", + "sdk-reference/js-sdk/v2.1.4/errors/index", + "sdk-reference/js-sdk/v2.1.4/filesystem/index", + "sdk-reference/js-sdk/v2.1.4/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.3", + "groups": [ + { + "group": "JavaScript SDK v2.1.3", + "pages": [ + "sdk-reference/js-sdk/v2.1.3/commands/index", + "sdk-reference/js-sdk/v2.1.3/errors/index", + "sdk-reference/js-sdk/v2.1.3/filesystem/index", + "sdk-reference/js-sdk/v2.1.3/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.2", + "groups": [ + { + "group": "JavaScript SDK v2.1.2", + "pages": [ + "sdk-reference/js-sdk/v2.1.2/commands/index", + "sdk-reference/js-sdk/v2.1.2/errors/index", + "sdk-reference/js-sdk/v2.1.2/filesystem/index", + "sdk-reference/js-sdk/v2.1.2/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.1", + "groups": [ + { + "group": "JavaScript SDK v2.1.1", + "pages": [ + "sdk-reference/js-sdk/v2.1.1/commands/index", + "sdk-reference/js-sdk/v2.1.1/errors/index", + "sdk-reference/js-sdk/v2.1.1/filesystem/index", + "sdk-reference/js-sdk/v2.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.0", + "groups": [ + { + "group": "JavaScript SDK v2.1.0", + "pages": [ + "sdk-reference/js-sdk/v2.1.0/commands/index", + "sdk-reference/js-sdk/v2.1.0/errors/index", + "sdk-reference/js-sdk/v2.1.0/filesystem/index", + "sdk-reference/js-sdk/v2.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.3", + "groups": [ + { + "group": "JavaScript SDK v2.0.3", + "pages": [ + "sdk-reference/js-sdk/v2.0.3/commands/index", + "sdk-reference/js-sdk/v2.0.3/errors/index", + "sdk-reference/js-sdk/v2.0.3/filesystem/index", + "sdk-reference/js-sdk/v2.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.2", + "groups": [ + { + "group": "JavaScript SDK v2.0.2", + "pages": [ + "sdk-reference/js-sdk/v2.0.2/commands/index", + "sdk-reference/js-sdk/v2.0.2/errors/index", + "sdk-reference/js-sdk/v2.0.2/filesystem/index", + "sdk-reference/js-sdk/v2.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.1", + "groups": [ + { + "group": "JavaScript SDK v2.0.1", + "pages": [ + "sdk-reference/js-sdk/v2.0.1/commands/index", + "sdk-reference/js-sdk/v2.0.1/errors/index", + "sdk-reference/js-sdk/v2.0.1/filesystem/index", + "sdk-reference/js-sdk/v2.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "JavaScript SDK v2.0.0", + "pages": [ + "sdk-reference/js-sdk/v2.0.0/commands/index", + "sdk-reference/js-sdk/v2.0.0/errors/index", + "sdk-reference/js-sdk/v2.0.0/filesystem/index", + "sdk-reference/js-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.13.2", + "groups": [ + { + "group": "JavaScript SDK v1.13.2", + "pages": [ + "sdk-reference/js-sdk/v1.13.2/commands/index", + "sdk-reference/js-sdk/v1.13.2/errors/index", + "sdk-reference/js-sdk/v1.13.2/filesystem/index", + "sdk-reference/js-sdk/v1.13.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.13.1", + "groups": [ + { + "group": "JavaScript SDK v1.13.1", + "pages": [ + "sdk-reference/js-sdk/v1.13.1/commands/index", + "sdk-reference/js-sdk/v1.13.1/errors/index", + "sdk-reference/js-sdk/v1.13.1/filesystem/index", + "sdk-reference/js-sdk/v1.13.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.13.0", + "groups": [ + { + "group": "JavaScript SDK v1.13.0", + "pages": [ + "sdk-reference/js-sdk/v1.13.0/commands/index", + "sdk-reference/js-sdk/v1.13.0/errors/index", + "sdk-reference/js-sdk/v1.13.0/filesystem/index", + "sdk-reference/js-sdk/v1.13.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.12.0", + "groups": [ + { + "group": "JavaScript SDK v1.12.0", + "pages": [ + "sdk-reference/js-sdk/v1.12.0/commands/index", + "sdk-reference/js-sdk/v1.12.0/errors/index", + "sdk-reference/js-sdk/v1.12.0/filesystem/index", + "sdk-reference/js-sdk/v1.12.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.11.0", + "groups": [ + { + "group": "JavaScript SDK v1.11.0", + "pages": [ + "sdk-reference/js-sdk/v1.11.0/commands/index", + "sdk-reference/js-sdk/v1.11.0/errors/index", + "sdk-reference/js-sdk/v1.11.0/filesystem/index", + "sdk-reference/js-sdk/v1.11.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.10.0", + "groups": [ + { + "group": "JavaScript SDK v1.10.0", + "pages": [ + "sdk-reference/js-sdk/v1.10.0/commands/index", + "sdk-reference/js-sdk/v1.10.0/errors/index", + "sdk-reference/js-sdk/v1.10.0/filesystem/index", + "sdk-reference/js-sdk/v1.10.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.1", + "groups": [ + { + "group": "JavaScript SDK v1.9.1", + "pages": [ + "sdk-reference/js-sdk/v1.9.1/commands/index", + "sdk-reference/js-sdk/v1.9.1/errors/index", + "sdk-reference/js-sdk/v1.9.1/filesystem/index", + "sdk-reference/js-sdk/v1.9.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "JavaScript SDK v1.9.0", + "pages": [ + "sdk-reference/js-sdk/v1.9.0/commands/index", + "sdk-reference/js-sdk/v1.9.0/errors/index", + "sdk-reference/js-sdk/v1.9.0/filesystem/index", + "sdk-reference/js-sdk/v1.9.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "JavaScript SDK v1.8.0", + "pages": [ + "sdk-reference/js-sdk/v1.8.0/commands/index", + "sdk-reference/js-sdk/v1.8.0/errors/index", + "sdk-reference/js-sdk/v1.8.0/filesystem/index", + "sdk-reference/js-sdk/v1.8.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "JavaScript SDK v1.7.1", + "pages": [ + "sdk-reference/js-sdk/v1.7.1/commands/index", + "sdk-reference/js-sdk/v1.7.1/errors/index", + "sdk-reference/js-sdk/v1.7.1/filesystem/index", + "sdk-reference/js-sdk/v1.7.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "JavaScript SDK v1.7.0", + "pages": [ + "sdk-reference/js-sdk/v1.7.0/commands/index", + "sdk-reference/js-sdk/v1.7.0/errors/index", + "sdk-reference/js-sdk/v1.7.0/filesystem/index", + "sdk-reference/js-sdk/v1.7.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "JavaScript SDK v1.6.0", + "pages": [ + "sdk-reference/js-sdk/v1.6.0/commands/index", + "sdk-reference/js-sdk/v1.6.0/errors/index", + "sdk-reference/js-sdk/v1.6.0/filesystem/index", + "sdk-reference/js-sdk/v1.6.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.3", + "groups": [ + { + "group": "JavaScript SDK v1.5.3", + "pages": [ + "sdk-reference/js-sdk/v1.5.3/commands/index", + "sdk-reference/js-sdk/v1.5.3/errors/index", + "sdk-reference/js-sdk/v1.5.3/filesystem/index", + "sdk-reference/js-sdk/v1.5.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "JavaScript SDK v1.5.2", + "pages": [ + "sdk-reference/js-sdk/v1.5.2/commands/index", + "sdk-reference/js-sdk/v1.5.2/errors/index", + "sdk-reference/js-sdk/v1.5.2/filesystem/index", + "sdk-reference/js-sdk/v1.5.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "JavaScript SDK v1.5.1", + "pages": [ + "sdk-reference/js-sdk/v1.5.1/commands/index", + "sdk-reference/js-sdk/v1.5.1/errors/index", + "sdk-reference/js-sdk/v1.5.1/filesystem/index", + "sdk-reference/js-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "JavaScript SDK v1.5.0", + "pages": [ + "sdk-reference/js-sdk/v1.5.0/commands/index", + "sdk-reference/js-sdk/v1.5.0/errors/index", + "sdk-reference/js-sdk/v1.5.0/filesystem/index", + "sdk-reference/js-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "JavaScript SDK v1.4.0", + "pages": [ + "sdk-reference/js-sdk/v1.4.0/commands/index", + "sdk-reference/js-sdk/v1.4.0/errors/index", + "sdk-reference/js-sdk/v1.4.0/filesystem/index", + "sdk-reference/js-sdk/v1.4.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "JavaScript SDK v1.3.0", + "pages": [ + "sdk-reference/js-sdk/v1.3.0/commands/index", + "sdk-reference/js-sdk/v1.3.0/errors/index", + "sdk-reference/js-sdk/v1.3.0/filesystem/index", + "sdk-reference/js-sdk/v1.3.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.5", + "groups": [ + { + "group": "JavaScript SDK v1.2.5", + "pages": [ + "sdk-reference/js-sdk/v1.2.5/commands/index", + "sdk-reference/js-sdk/v1.2.5/errors/index", + "sdk-reference/js-sdk/v1.2.5/filesystem/index", + "sdk-reference/js-sdk/v1.2.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.4", + "groups": [ + { + "group": "JavaScript SDK v1.2.4", + "pages": [ + "sdk-reference/js-sdk/v1.2.4/commands/index", + "sdk-reference/js-sdk/v1.2.4/errors/index", + "sdk-reference/js-sdk/v1.2.4/filesystem/index", + "sdk-reference/js-sdk/v1.2.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.3", + "groups": [ + { + "group": "JavaScript SDK v1.2.3", + "pages": [ + "sdk-reference/js-sdk/v1.2.3/commands/index", + "sdk-reference/js-sdk/v1.2.3/errors/index", + "sdk-reference/js-sdk/v1.2.3/filesystem/index", + "sdk-reference/js-sdk/v1.2.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.2", + "groups": [ + { + "group": "JavaScript SDK v1.2.2", + "pages": [ + "sdk-reference/js-sdk/v1.2.2/commands/index", + "sdk-reference/js-sdk/v1.2.2/errors/index", + "sdk-reference/js-sdk/v1.2.2/filesystem/index", + "sdk-reference/js-sdk/v1.2.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "JavaScript SDK v1.2.1", + "pages": [ + "sdk-reference/js-sdk/v1.2.1/commands/index", + "sdk-reference/js-sdk/v1.2.1/errors/index", + "sdk-reference/js-sdk/v1.2.1/filesystem/index", + "sdk-reference/js-sdk/v1.2.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "JavaScript SDK v1.2.0", + "pages": [ + "sdk-reference/js-sdk/v1.2.0/commands/index", + "sdk-reference/js-sdk/v1.2.0/errors/index", + "sdk-reference/js-sdk/v1.2.0/filesystem/index", + "sdk-reference/js-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "JavaScript SDK v1.1.1", + "pages": [ + "sdk-reference/js-sdk/v1.1.1/commands/index", + "sdk-reference/js-sdk/v1.1.1/errors/index", + "sdk-reference/js-sdk/v1.1.1/filesystem/index", + "sdk-reference/js-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "JavaScript SDK v1.1.0", + "pages": [ + "sdk-reference/js-sdk/v1.1.0/commands/index", + "sdk-reference/js-sdk/v1.1.0/errors/index", + "sdk-reference/js-sdk/v1.1.0/filesystem/index", + "sdk-reference/js-sdk/v1.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.7", + "groups": [ + { + "group": "JavaScript SDK v1.0.7", + "pages": [ + "sdk-reference/js-sdk/v1.0.7/commands/index", + "sdk-reference/js-sdk/v1.0.7/errors/index", + "sdk-reference/js-sdk/v1.0.7/filesystem/index", + "sdk-reference/js-sdk/v1.0.7/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.6", + "groups": [ + { + "group": "JavaScript SDK v1.0.6", + "pages": [ + "sdk-reference/js-sdk/v1.0.6/commands/index", + "sdk-reference/js-sdk/v1.0.6/errors/index", + "sdk-reference/js-sdk/v1.0.6/filesystem/index", + "sdk-reference/js-sdk/v1.0.6/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "JavaScript SDK v1.0.5", + "pages": [ + "sdk-reference/js-sdk/v1.0.5/commands/index", + "sdk-reference/js-sdk/v1.0.5/errors/index", + "sdk-reference/js-sdk/v1.0.5/filesystem/index", + "sdk-reference/js-sdk/v1.0.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "JavaScript SDK v1.0.4", + "pages": [ + "sdk-reference/js-sdk/v1.0.4/errors/index", + "sdk-reference/js-sdk/v1.0.4/filesystem/index", + "sdk-reference/js-sdk/v1.0.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "JavaScript SDK v1.0.3", + "pages": [ + "sdk-reference/js-sdk/v1.0.3/errors/index", + "sdk-reference/js-sdk/v1.0.3/filesystem/index", + "sdk-reference/js-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "JavaScript SDK v1.0.2", + "pages": [ + "sdk-reference/js-sdk/v1.0.2/errors/index", + "sdk-reference/js-sdk/v1.0.2/filesystem/index", + "sdk-reference/js-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "JavaScript SDK v1.0.1", + "pages": [ + "sdk-reference/js-sdk/v1.0.1/errors/index", + "sdk-reference/js-sdk/v1.0.1/filesystem/index", + "sdk-reference/js-sdk/v1.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.0", + "groups": [ + { + "group": "JavaScript SDK v1.0.0", + "pages": [ + "sdk-reference/js-sdk/v1.0.0/errors/index", + "sdk-reference/js-sdk/v1.0.0/filesystem/index", + "sdk-reference/js-sdk/v1.0.0/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Python SDK", + "icon": "python", + "versions": [ + { + "version": "v2.1.3@latest", + "groups": [ + { + "group": "Python SDK v2.1.3", + "pages": [ + "sdk-reference/python-sdk/v2.1.3/exceptions/index", + "sdk-reference/python-sdk/v2.1.3/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.1.2", + "groups": [ + { + "group": "Python SDK v2.1.2", + "pages": [ + "sdk-reference/python-sdk/v2.1.2/exceptions/index", + "sdk-reference/python-sdk/v2.1.2/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.1.1", + "groups": [ + { + "group": "Python SDK v2.1.1", + "pages": [ + "sdk-reference/python-sdk/v2.1.1/exceptions/index", + "sdk-reference/python-sdk/v2.1.1/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.1.0", + "groups": [ + { + "group": "Python SDK v2.1.0", + "pages": [ + "sdk-reference/python-sdk/v2.1.0/exceptions/index", + "sdk-reference/python-sdk/v2.1.0/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.0.2", + "groups": [ + { + "group": "Python SDK v2.0.2", + "pages": [ + "sdk-reference/python-sdk/v2.0.2/exceptions/index", + "sdk-reference/python-sdk/v2.0.2/sandbox_async/index", + "sdk-reference/python-sdk/v2.0.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.0.1", + "groups": [ + { + "group": "Python SDK v2.0.1", + "pages": [ + "sdk-reference/python-sdk/v2.0.1/exceptions/index", + "sdk-reference/python-sdk/v2.0.1/sandbox_async/index", + "sdk-reference/python-sdk/v2.0.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "Python SDK v2.0.0", + "pages": [ + "sdk-reference/python-sdk/v2.0.0/exceptions/index", + "sdk-reference/python-sdk/v2.0.0/sandbox_async/index", + "sdk-reference/python-sdk/v2.0.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.11.1", + "groups": [ + { + "group": "Python SDK v1.11.1", + "pages": [ + "sdk-reference/python-sdk/v1.11.1/exceptions/index", + "sdk-reference/python-sdk/v1.11.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.11.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.11.0", + "groups": [ + { + "group": "Python SDK v1.11.0", + "pages": [ + "sdk-reference/python-sdk/v1.11.0/exceptions/index", + "sdk-reference/python-sdk/v1.11.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.11.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.10.0", + "groups": [ + { + "group": "Python SDK v1.10.0", + "pages": [ + "sdk-reference/python-sdk/v1.10.0/exceptions/index", + "sdk-reference/python-sdk/v1.10.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.10.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "Python SDK v1.9.0", + "pages": [ + "sdk-reference/python-sdk/v1.9.0/exceptions/index", + "sdk-reference/python-sdk/v1.9.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.9.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "Python SDK v1.8.0", + "pages": [ + "sdk-reference/python-sdk/v1.8.0/exceptions/index", + "sdk-reference/python-sdk/v1.8.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.8.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "Python SDK v1.7.1", + "pages": [ + "sdk-reference/python-sdk/v1.7.1/exceptions/index", + "sdk-reference/python-sdk/v1.7.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.7.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "Python SDK v1.7.0", + "pages": [ + "sdk-reference/python-sdk/v1.7.0/exceptions/index", + "sdk-reference/python-sdk/v1.7.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.7.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "Python SDK v1.6.0", + "pages": [ + "sdk-reference/python-sdk/v1.6.0/exceptions/index", + "sdk-reference/python-sdk/v1.6.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.6.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.6", + "groups": [ + { + "group": "Python SDK v1.5.6", + "pages": [ + "sdk-reference/python-sdk/v1.5.6/exceptions/index", + "sdk-reference/python-sdk/v1.5.6/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.6/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.5", + "groups": [ + { + "group": "Python SDK v1.5.5", + "pages": [ + "sdk-reference/python-sdk/v1.5.5/exceptions/index", + "sdk-reference/python-sdk/v1.5.5/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.5/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.4", + "groups": [ + { + "group": "Python SDK v1.5.4", + "pages": [ + "sdk-reference/python-sdk/v1.5.4/exceptions/index", + "sdk-reference/python-sdk/v1.5.4/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.4/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.3", + "groups": [ + { + "group": "Python SDK v1.5.3", + "pages": [ + "sdk-reference/python-sdk/v1.5.3/exceptions/index", + "sdk-reference/python-sdk/v1.5.3/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "Python SDK v1.5.2", + "pages": [ + "sdk-reference/python-sdk/v1.5.2/exceptions/index", + "sdk-reference/python-sdk/v1.5.2/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Python SDK v1.5.1", + "pages": [ + "sdk-reference/python-sdk/v1.5.1/exceptions/index", + "sdk-reference/python-sdk/v1.5.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Python SDK v1.5.0", + "pages": [ + "sdk-reference/python-sdk/v1.5.0/exceptions/index", + "sdk-reference/python-sdk/v1.5.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "Python SDK v1.4.0", + "pages": [ + "sdk-reference/python-sdk/v1.4.0/exceptions/index", + "sdk-reference/python-sdk/v1.4.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.4.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.5", + "groups": [ + { + "group": "Python SDK v1.3.5", + "pages": [ + "sdk-reference/python-sdk/v1.3.5/exceptions/index", + "sdk-reference/python-sdk/v1.3.5/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.5/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.4", + "groups": [ + { + "group": "Python SDK v1.3.4", + "pages": [ + "sdk-reference/python-sdk/v1.3.4/exceptions/index", + "sdk-reference/python-sdk/v1.3.4/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.4/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.3", + "groups": [ + { + "group": "Python SDK v1.3.3", + "pages": [ + "sdk-reference/python-sdk/v1.3.3/exceptions/index", + "sdk-reference/python-sdk/v1.3.3/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.2", + "groups": [ + { + "group": "Python SDK v1.3.2", + "pages": [ + "sdk-reference/python-sdk/v1.3.2/exceptions/index", + "sdk-reference/python-sdk/v1.3.2/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.1", + "groups": [ + { + "group": "Python SDK v1.3.1", + "pages": [ + "sdk-reference/python-sdk/v1.3.1/exceptions/index", + "sdk-reference/python-sdk/v1.3.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "Python SDK v1.3.0", + "pages": [ + "sdk-reference/python-sdk/v1.3.0/exceptions/index", + "sdk-reference/python-sdk/v1.3.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "Python SDK v1.2.1", + "pages": [ + "sdk-reference/python-sdk/v1.2.1/exceptions/index", + "sdk-reference/python-sdk/v1.2.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.2.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Python SDK v1.2.0", + "pages": [ + "sdk-reference/python-sdk/v1.2.0/exceptions/index", + "sdk-reference/python-sdk/v1.2.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.2.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "Python SDK v1.1.0", + "pages": [ + "sdk-reference/python-sdk/v1.1.0/exceptions/index", + "sdk-reference/python-sdk/v1.1.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.1.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.6", + "groups": [ + { + "group": "Python SDK v1.0.6", + "pages": [ + "sdk-reference/python-sdk/v1.0.6/exceptions/index", + "sdk-reference/python-sdk/v1.0.6/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.6/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "Python SDK v1.0.5", + "pages": [ + "sdk-reference/python-sdk/v1.0.5/exceptions/index", + "sdk-reference/python-sdk/v1.0.5/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.5/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "Python SDK v1.0.4", + "pages": [ + "sdk-reference/python-sdk/v1.0.4/exceptions/index", + "sdk-reference/python-sdk/v1.0.4/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.4/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Python SDK v1.0.3", + "pages": [ + "sdk-reference/python-sdk/v1.0.3/exceptions/index", + "sdk-reference/python-sdk/v1.0.3/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Python SDK v1.0.2", + "pages": [ + "sdk-reference/python-sdk/v1.0.2/exceptions/index", + "sdk-reference/python-sdk/v1.0.2/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Python SDK v1.0.1", + "pages": [ + "sdk-reference/python-sdk/v1.0.1/exceptions/index", + "sdk-reference/python-sdk/v1.0.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.0", + "groups": [ + { + "group": "Python SDK v1.0.0", + "pages": [ + "sdk-reference/python-sdk/v1.0.0/exceptions/index", + "sdk-reference/python-sdk/v1.0.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.0/sandbox_sync/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Code Interpreter JavaScript SDK", + "icon": "square-js", + "versions": [ + { + "version": "v2.0.0@latest", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v2.0.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v2.0.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.5.1", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.5.1/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.5.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.5.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.2.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.2.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.1.1", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.1.1/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.1.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.1.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.0.4", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Code Interpreter Python SDK", + "icon": "python", + "versions": [ + { + "version": "v2.0.0@latest", + "groups": [ + { + "group": "Code Interpreter Python SDK v2.0.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.5.2", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.5.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.5.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.5.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.2.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.2.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.2.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.1.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.1.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.5", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.4", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.3", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.2", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.1/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Desktop JavaScript SDK", + "icon": "square-js", + "versions": [ + { + "version": "v2.0.1@latest", + "groups": [ + { + "group": "Desktop JavaScript SDK v2.0.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v2.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v2.0.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.9.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.9.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.9.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.9.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.9.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.9.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.8.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.8.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.8.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.8.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.8.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.3", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.3", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.6.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.6.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.6.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.6.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.6.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.6.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.5.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.4.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.4.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.3.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.3.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.2.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.1.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.0.3", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.0.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.0.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.0.1/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Desktop Python SDK", + "icon": "python", + "versions": [ + { + "version": "v2.0.1@latest", + "groups": [ + { + "group": "Desktop Python SDK v2.0.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v2.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "Desktop Python SDK v2.0.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.4", + "groups": [ + { + "group": "Desktop Python SDK v1.7.4", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.3", + "groups": [ + { + "group": "Desktop Python SDK v1.7.3", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.2", + "groups": [ + { + "group": "Desktop Python SDK v1.7.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "Desktop Python SDK v1.7.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "Desktop Python SDK v1.7.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.5", + "groups": [ + { + "group": "Desktop Python SDK v1.6.5", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.4", + "groups": [ + { + "group": "Desktop Python SDK v1.6.4", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.3", + "groups": [ + { + "group": "Desktop Python SDK v1.6.3", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.2", + "groups": [ + { + "group": "Desktop Python SDK v1.6.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.1", + "groups": [ + { + "group": "Desktop Python SDK v1.6.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "Desktop Python SDK v1.6.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "Desktop Python SDK v1.5.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.5.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Desktop Python SDK v1.5.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Desktop Python SDK v1.5.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "Desktop Python SDK v1.4.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.4.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "Desktop Python SDK v1.3.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.3.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Desktop Python SDK v1.2.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Desktop Python SDK v1.1.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Desktop Python SDK v1.0.3", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Desktop Python SDK v1.0.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Desktop Python SDK v1.0.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.0.1/sandbox/index" + ] + } + ] + } + ] + } + ] + } + ], + "global": {} + }, + "logo": { + "light": "/logo/logo_light.svg", + "dark": "/logo/logo_dark.svg" + }, + "appearance": { + "default": "dark" + }, + "background": { + "color": { + "light": "#ffffff", + "dark": "#000000" + }, + "decoration": "windows" + }, + "navbar": { + "links": [ + { + "label": "Sign in", + "href": "https://e2b.dev/auth/sign-in?redirect_to=https%3A%2F%2Fe2b.dev%2Fdocs" + }, + { + "label": "Dashboard", + "href": "https://e2b.dev/dashboard" + } + ], + "primary": { + "type": "github", + "href": "https://github.com/e2b-dev/e2b" + } + }, + "footer": { + "socials": { + "x": "https://x.com/mintlify", + "github": "https://github.com/mintlify", + "linkedin": "https://linkedin.com/company/mintlify" + } + }, + "fonts": { + "heading": { + "family": "IBM Plex Mono", + "weight": 700 + }, + "body": { + "family": "IBM Plex Mono", + "weight": 400 + } + } +} \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/favicon.ico b/apps/web/src/app/(docs)/mintlify-docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..0e138eb9e43d44eab6b034ecbea961b26db543a2 GIT binary patch literal 4286 zcmb_gZ-`V?6u;wsSX!|rOGy{$ehHR9nZ86pxkE@nip__h=tDkpu@8bffnUO4wm*=T zFhe3GB5!Dkf~X-df*^K-#FXG6ZK)7FiTt9lV-Oi>@7MXgo%8n1oA=(n3D5G|d+)jD zp5M9W+`EjWH7fQJJcM`cP!fl z6V@B1MqTkU(E*JrbWFLK4j%3xqU_ZP1-Z8%n0TwFxA z+eHurp(<%>#w^Ub>VV%K7dcf@_ugnULciQ2bI!VJ?m5An6Ds@m*Rg7%22*XL^sJB4 zi$G~hBa7edk+T-@w=A;fnb!O&N4#Zz2+GZWfm6Q#kIn*j912i+4KPza%xLbtAh#ok zIN8_x#eB}p%)}}C`f7Je(*NsqV0J;yobhnxN`Rx^b+P014mM8i!UKnV+;&Bj`(14PD8Pd!fbnC%=u@fOTu<)Q+S7Ml49cBs zcf8uh)K|bWp8-{gVM8sGoBWyF>UWqJ_Ppuh$T{HPw*mHj4QzfsmpjUza;3G&^T+#^ zW=Gvi2b=hCA;5b-0B@ZJ9^YMvKQjlzaBED{hh2R9bAaO>@b32kp4hW|Zqz2$lG}@o zqrK&E^XyeBmB@Bd#*b}XK7X&g#2_Hx-R4LExR*i~;}{kX-w8!g7xq`rgX<{KF0GTtBN{bdX{ZUWc-lDA3T!Uc)pi?cq~ z+?mQtKGvSxlz|$EE_!>JU!Hq@f2OCWNfiop?RHy-Xf~VJzO#lm4mUA>-p7wufxQP( z^G^O2iF;zD9moOC8FL(;<5-2?UP2{lJHE+c=W|Zq`j{_r#-%BPEZaUk&mM(&A+%p~ zz1Wc}DXfJr=;KNoGw&4UN58-PyCBUrMMn;;yL9`+%4o$Hcn)o`)N%8 literal 0 HcmV?d00001 diff --git a/apps/web/src/app/(docs)/mintlify-docs/favicon.jpeg b/apps/web/src/app/(docs)/mintlify-docs/favicon.jpeg new file mode 100644 index 0000000000000000000000000000000000000000..b2a07736789ef543d1a8b2d146ad317155f56344 GIT binary patch literal 5485 zcmb7HbyyT#-=1B%cPZ%-q>)@wYH2}2nx(@f1!+Yj6_8p&x`hRnl*S;XI~4&zLP8V} z>3CP4_j%s$`>yw&@65Sot~vMl&D=A;bMEW@U46J(0w7vynrZ+D1OOoH0bG3o-~bL7 z{JUctF1F(l;^E=q;t>-N;1iM(lai7UlaP>+Q$ondq2wea5LyV7ikgOohLqwO9W6B- zB{dE8?}vbJurauJM0j{a)MO-N)c@~x)d@fefj*!Q2gCt@p&%S6=&BoF#*)NR`_1?7 zMnH&9gk=c=V_^m?fCc{t3gF`5W9MJZ0i-zCPzVkL`=#X}e+U2XD>>rxcr*T+x*=BE z8}FnXKJ@(s3nX+l)oBYf(7qB%(FnGQUF|HJejK{JE5>UQkLm214Ut{NPTUz;eOyay z>lC}fcqsd9<<}7&@13q+X0=7I_xr(3&#J$oJDzo<-Kml8-4hb$*zt8ZCKv;Nx`rrs zeFMQ3gB9jbL$T>zOuA|7hM=}4-G}?ER>K)9TVsg*8HM*xvLHhIzu8!A_^sq=mBUf( zpggNv_f0b~B=nU1%uFTmkv9mRxTg^5w*vsJXq&0s@?&(PaJa4P$u}CtuGVHyRoNGU z4{6LM0ce|mV!=w!%vPy&vAano@9xOb>EF%^e;h~AhJArp&U3@uez!N}6wFzACk*{h zTMh+j26~N|`y_rE**|zFktNi#<2ee}jyy%1n?#*57eJ{Z8m{ZCdwU~JZK2&idjuL(n-?21%u95y1@ z6cS=H3&I0m0hZ4x>(-j45Qdz1%7tG(v!_wkIG$!Mie)11r-s!lUP=UO(b$yl%5sRM z&IgyEVo#V`U1!4m)q*aFRc{clSSL>;>_*Et%qx`C$F8L;&v4Dc9eccGJmb(hw+VN| z&v;rUZTa-9v~Fb>Ij;&zLpb@p49bvVsM9aT)bE91cm)%G z9(mJ8CdsPKe8-qU`Z@uTFfo5lx44j=L28M2?e-QiDGLsqjVkAfg%hIvjs{^VH`7M0 z_g5aOlWo6}Xu~_x<6+V>2zznU|K0WB@>c_nl@HxW_0!!h>w~;Lx@nmj^mLD0K!Pp3 zs>ludqB&t|eHW#(ZIKm%!D|mnJ^A*w<2)afsA#g+9*UIdr|@pt(!b2EaJv;SgQ4SL zxM;|Q-PM)q=5(HfhUNH(lIWS8J$Jktra+>-Iz8?&+b?vaKz)KXrh|EYv!C4zid~;( zSB+Woy+(LQZuE_%&Sl4#NP8T$(CtHE(;||`?lk0?aExFnZ_+}pI_+Q;~o@}bmemylT*9Hk?g2b zLg1wNQ#N6$Bg4IJp-S3=;yvHWi`*+f-mzu$@-=o1-hcuiT&z^!{j)%^T7iQLrDPYz zqoNkkQ}!yTUH-EGv5Qmzw72}SP;{rBZF>x7^tNH5(kmRA8DnHr$#d&QxWoAQD*~ zz-oEIS}(g*P~LyWH!feVGT;R=YwFtRMSVY3cgcB|`T-SXbUb`*<)C}v+#-jq%(HjT-R%a(+)z!! zHk2x31J%o9 z$#y9T#GdA6g{f{}zQ}k*7ll!++ht1n-5)a)e1od4KSZaGzM4mI?mF(@M`NlNUPPM{ z8W`RnoD7??v?f2jaD;JxR!j*=31!2NWuecbid^*LPF`+*$%DtGtimkbKxEQY(`G67 z-13;Zn2}c_gIkq3is1ct|Et`pwkNPb5Ynx+=D7zwr>-VCwLQr7qJF=bBJN3JZ2JsF z{aHm4qy(LjZ(mr&>b`wLZAWpC%n>Rrw6!BY?WI17X93Zk_4TWE2|%w!Sj&Ba#YQ%O zWMm1zKi#A@K`svhGu8M44X<@qf70a(KTbVEZgXjxxvRnwosz$;XO?430-0twjK;Pw zPV+)0MuLsw**|sYX;1qvx@Prw+%(oB{^dJ+sx?* zjLWRFK!SYki;lW%m-0%>Rd3U16L@)LmS>Ckw9fH6@7>J}-{iWr1r ze^xB-tZ}b;DdW!alMk-iA$1nb-}>Mnya?J2vx$Bl>$N^{&2M2GM@=l*ohUROUNrR> zrW;W3Hq=X#`9|}KFVw`CuQzjY;2e!xudkozycdLV^HGR*PD`0!A*>Vgj}aAqp+m~)1+;H4Y_3-NXWB=)z8QBVB#WeUL$j@ai0GkX@=p)dLnH>`6|Re;F&H_2$eq?2LaL~j9Ajug5bb>O zq^G8WSS#{nsYbYJ-Nw&E-*}(OS%hD0lo8s(y-pY(nX7wIK=T-p;)2jZH$UEhr#_Ek zJ77N%X^p(CZxCz-gI2nuPXU?=1PE)Hs+2pN^ZMIWp7O-Nm{PEswF^d>J{kbQD zR{&OC`5;(-g9FCH{m0>gpa8pwk}X8vE3`lu)v>Es%Qn7j^S6kC6xgqTD&$gvVY|Mw z+NY>>h1%IrXV=1I*J|*lju{P-PWOGQmK%KOZ2ZJ=E&=LMvuS;j6BX|x|Lw>7R@K(Q zN;5%8_T9&Av_YoJ$v@hr2SZsLg2^>-Ilc|lYI4jxFHiXCl|x3+V!ljm@|m1@USBIf z!C!TkZt&SXYJ*&I-|&*$zNtAT3_AbFg~CuON{tO77}z!46BuVvl(`#+9IHLSiCFfb zSNLv7GA{?TQ-@$csg>#%H4*m%msEP_O7%4$yT3;0u_DJ{V9rBV*knk#q@U1ATl zoYKtKSrpKy=j6pN0KXry+ECcO>q0QXHSHsH-*LPJ?5|BRVouBVTv1& z^*K9d1~IdN@E0Fy`R`7AsAcKi9gnq-92ht;vw632Cp}s`Er;8;V^d;}Zw~Ia|IL%& zh0y{2@Y+K0L5H*U)3DBD3Lek5T!#z?qj(FURY&{2n|Zo+-H)ic)I?%5*;@>_zf-)C z8=YkBwFAy{+h<7Mx0eZk)U6YIy>dlwb$O)YKa+G&VldZDvaAK=i%M=$<_~Mc9x&C$kG z?FDn?+0LXP((E(faThnU27T+=NMH(*DhG89iZ1K9nW5nOs%c4+S@&Gbn^R0zkvPe| zY50rj;z#5;pUCE5O88(la^^n!v(f=VjdbK7h;Yj!@Y?jKnjRsJ);)j=p{Kv~W1E31 z6Ea|fny7X*dDwi|d*3Ll)~q`f^8Blj%H#4j)*TB&5dz+@BXhqv{?s2PLGGzRdBH4> zx*}0g>)E?a+a8$JGkr-~O3I@4N4k=wRkqQ~mmBAYH{cO3KFb7?9*Z3bAsC+x(5mxm z@2eC3=cwF&>jJg9f5wNfXZcUqIU@pf zy$m{U&#{y3Nd(xs{-7jGyGOy;k^QG~uS(^PeuogEx_K)<|3QbDCja}x|DbZB9nd(ga@vGo6G3h z?YiSH9gdPBY`vZS;_2jck_Pf00jDS!^GKt;3Q?V5aN~FH5NgKaa}%?5sX*_Kx~=>4 zGhaIC0Xk?{mY?PHM_r+Y#DE1Z|6NB05M2Fu=0WD1wUjsCLge-rxvg}!Z_7Z7jvPPF=Z8#g{HXZ2c{-mpVK zIxs1Vn`ER+wsk2+z7`=&*7>v{qbQ|7lEJ2wT!-37Ilp(mFVhCUR{X1+Az(*$K-(x_&jo?=sY(vL9KYnia_nR2p1Grh%qiwSi5V9 z1fY}Q$s_$vh``1eTX0f9>K`Emi%NTDp4a#n<~9VneQBk?8MmIgaqm$ojRVBu77dM- z2CNoQV4~XT;f3_0KJ^m~?X>i<8i}*M4@asHLHj03xbO{EuK=+xFTQEv%1;>aNLMB(8pR`B?2^Np%@1eq%OQUDeL zF!^u|bt=IK!-DiE9_*8K`|^&}oIoOUwDxVZFA>2qFb5d`0&2K5-v|&HdEUiYqK3b| z%R^1X*3Urg!jVdZTA+GSIhbqB)8_Nt(EfHFGWHd_(I7SQbt7%k5L7R@C;npE7o+>Z z%mB5(OyJgb#w(B|v1yB;BGi+O3D;;*VvLSiaeWHQ2!CbBb^7|&&rQ{a&KPh%;Xc`A z{K4hAW*g#Q{Pn$S+qC5uV)q2T5EcDOz?4cfw?BT293jg|O4DP&r$kvDG&LR3XN|{; zGKD=;lm*ip+3<@Ahn%%37#U}_DhDX#^G9?*1Hfz@_fY1@Z*@1gZC-ZWOHmcwT1((H JIeT*T@m~tje + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/filesystem/download/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/filesystem/download/index.mdx new file mode 100644 index 0000000000..bdd178e8c3 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/filesystem/download/index.mdx @@ -0,0 +1,70 @@ +--- +sidebarTitle: Download data +title: "Download data from sandbox" +--- + +You can download data from the sandbox using the `files.read()` method. + + +```js JavaScript & TypeScript +import fs from 'fs' +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// Read file from sandbox +const content = await sandbox.files.read('/path/in/sandbox') +// Write file to local filesystem +fs.writeFileSync('/local/path', content) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Read file from sandbox +content = sandbox.files.read('/path/in/sandbox') +# Write file to local filesystem +with open('/local/path', 'w') as file: + file.write(content) +``` + + + +## Download with pre-signed URL + +Sometimes, you may want to let users from unauthorized environments, like a browser, download files from the sandbox. +For this use case, you can use pre-signed URLs to let users download files securely. + +All you need to do is create a sandbox with the `secure: true` option. A download URL will then be generated with a signature that allows only authorized users to access files. +You can optionally set an expiration time for the URL so that it will be valid only for a limited time. + +```js JavaScript & TypeScript +import fs from 'fs' +import { Sandbox } from '@e2b/code-interpreter' + +// Start a secured sandbox (all operations must be authorized by default) +const sandbox = await Sandbox.create(template, { secure: true }) + +// Create a pre-signed URL for file download with a 10 second expiration +const publicUrl = await sandbox.downloadUrl( + 'demo.txt', { + useSignatureExpiration: 10_000, // optional + }, +) + +// Download a file with a pre-signed URL (this can be used in any environment, such as a browser) +const res = await fetch(publicUrl) +const content = await res.text() +``` +```python Python +from e2b import Sandbox + +# Start a secured sandbox (all operations must be authorized by default) +sandbox = Sandbox.create(timeout=12_000, secure=True) + +# Create a pre-signed URL for file download with a 10 second expiration +# The user only has to visit the URL to download the file, this also works in a browser. +signed_url = sbx.download_url(path="demo.txt", user="user", use_signature_expiration=10_000) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/filesystem/index.mdx new file mode 100644 index 0000000000..24dbfefede --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/filesystem/index.mdx @@ -0,0 +1,13 @@ +--- +title: "Filesystem" +sidebarTitle: Overview +--- + +Each E2B Sandbox has its own isolated filesystem. The [Hobby tier](https://e2b.dev/pricing) sandboxes come with 1 GB of the free disk space and [Pro tier](https://e2b.dev/pricing) sandboxes come with 5 GB. + +With E2B SDK you can: +- [Read and write files to the sandbox.](/filesystem/read-write) +- [Watch directory for changes.](/filesystem/watch) +- [Upload data to the sandbox.](/filesystem/upload) +- [Download data from the sandbox.](/filesystem/download) + diff --git a/apps/web/src/app/(docs)/mintlify-docs/filesystem/info/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/filesystem/info/index.mdx new file mode 100644 index 0000000000..47d8858ea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/filesystem/info/index.mdx @@ -0,0 +1,116 @@ +--- +title: "Get information about a file or directory" +sidebarTitle: File & directory metadata +--- + +You can get information about a file or directory using the `files.getInfo()` / `files.get_info()` methods. Information such as file name, type, and path is returned. + +### Getting information about a file + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// Create a new file +await sandbox.files.write('test_file.txt', 'Hello, world!') + +// Get information about the file +const info = await sandbox.files.getInfo('test_file.txt') + +console.log(info) +// { +// name: 'test_file.txt', +// type: 'file', +// path: '/home/user/test_file.txt', +// size: 13, +// mode: 0o644, +// permissions: '-rw-r--r--', +// owner: 'user', +// group: 'user', +// modifiedTime: '2025-05-26T12:00:00.000Z', +// symlinkTarget: null +// } +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Create a new file +sandbox.files.write('test_file', 'Hello, world!') + +# Get information about the file +info = sandbox.files.get_info('test_file') + +print(info) +# EntryInfo( +# name='test_file.txt', +# type=, +# path='/home/user/test_file.txt', +# size=13, +# mode=0o644, +# permissions='-rw-r--r--', +# owner='user', +# group='user', +# modified_time='2025-05-26T12:00:00.000Z', +# symlink_target=None +# ) +``` + + +### Getting information about a directory + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// Create a new directory +await sandbox.files.makeDir('test_dir') + +// Get information about the directory +const info = await sandbox.files.getInfo('test_dir') + +console.log(info) +// { +// name: 'test_dir', +// type: 'dir', +// path: '/home/user/test_dir', +// size: 0, +// mode: 0o755, +// permissions: 'drwxr-xr-x', +// owner: 'user', +// group: 'user', +// modifiedTime: '2025-05-26T12:00:00.000Z', +// symlinkTarget: null +// } +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Create a new directory +sandbox.files.make_dir('test_dir') + +# Get information about the directory +info = sandbox.files.get_info('test_dir') + +print(info) +# EntryInfo( +# name='test_dir', +# type=, +# path='/home/user/test_dir', +# size=0, +# mode=0o755, +# permissions='drwxr-xr-x', +# owner='user', +# group='user', +# modified_time='2025-05-26T12:00:00.000Z', +# symlink_target=None +# ) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/filesystem/read-write/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/filesystem/read-write/index.mdx new file mode 100644 index 0000000000..53a4571aee --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/filesystem/read-write/index.mdx @@ -0,0 +1,68 @@ +--- +title: "Read & write files" +sidebarTitle: Read & write +--- + +## Reading files + +You can read files from the sandbox filesystem using the `files.read()` method. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' +const sandbox = await Sandbox.create() +const fileContent = await sandbox.files.read('/path/to/file') +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() +file_content = sandbox.files.read('/path/to/file') +``` + + +## Writing single files + +You can write single files to the sandbox filesystem using the `files.write()` method. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' +const sandbox = await Sandbox.create() + +await sandbox.files.write('/path/to/file', 'file content') +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +await sandbox.files.write('/path/to/file', 'file content') +``` + + +## Writing multiple files + +You can also write multiple files to the sandbox. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' +const sandbox = await Sandbox.create() + +await sandbox.files.write([ + { path: '/path/to/a', data: 'file content' }, + { path: '/another/path/to/b', data: 'file content' } +]) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +await sandbox.files.write_files([ + { "path": "/path/to/a", "data": "file content" }, + { "path": "another/path/to/b", "data": "file content" } +]) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/filesystem/upload/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/filesystem/upload/index.mdx new file mode 100644 index 0000000000..45dda0bf7b --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/filesystem/upload/index.mdx @@ -0,0 +1,161 @@ +--- +title: "Upload data to sandbox" +sidebarTitle: Upload data +--- + +You can upload data to the sandbox using the `files.write()` method. + +## Upload single file + + +```js JavaScript & TypeScript +import fs from 'fs' +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// Read file from local filesystem +const content = fs.readFileSync('/local/path') +// Upload file to sandbox +await sandbox.files.write('/path/in/sandbox', content) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Read file from local filesystem +with open("path/to/local/file", "rb") as file: + # Upload file to sandbox + sandbox.files.write("/path/in/sandbox", file) +``` + + +## Upload with pre-signed URL + +Sometimes, you may want to let users from unauthorized environments, like a browser, upload files to the sandbox. +For this use case, you can use pre-signed URLs to let users upload files securely. + +All you need to do is create a sandbox with the `secure: true` option. An upload URL will then be generated with a signature that allows only authorized users to upload files. +You can optionally set an expiration time for the URL so that it will be valid only for a limited time. + +```js JavaScript & TypeScript +import fs from 'fs' +import { Sandbox } from '@e2b/code-interpreter' + +// Start a secured sandbox (all operations must be authorized by default) +const sandbox = await Sandbox.create(template, { secure: true }) + +// Create a pre-signed URL for file upload with a 10 second expiration +const publicUploadUrl = await sandbox.uploadUrl( + 'demo.txt', { + useSignatureExpiration: 10_000, // optional + }, +) + +// Upload a file with a pre-signed URL (this can be used in any environment, such as a browser) +const form = new FormData() +form.append('file', 'file content') + +await fetch(publicUploadUrl, { method: 'POST', body: form }) + +// File is now available in the sandbox and you can read it +const content = fs.readFileSync('demo.txt') +``` +```python Python +from e2b import Sandbox +import requests + +# Start a secured sandbox (all operations must be authorized by default) +sandbox = Sandbox.create(timeout=12_000, secure=True) + +# Create a pre-signed URL for file upload with a 10 second expiration +signed_url = sbx.upload_url(path="demo.txt", user="user", use_signature_expiration=10_000) + +form_data = {"file":"file content"} +requests.post(signed_url, data=form_data) +``` + + +## Upload directory / multiple files + + +```js JavaScript & TypeScript +const fs = require('fs'); +const path = require('path'); + +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// Read all files in the directory and store their paths and contents in an array +const readDirectoryFiles = (directoryPath) => { + // Read all files in the local directory + const files = fs.readdirSync(directoryPath); + + // Map files to objects with path and data + const filesArray = files + .filter(file => { + const fullPath = path.join(directoryPath, file); + // Skip if it's a directory + return fs.statSync(fullPath).isFile(); + }) + .map(file => { + const filePath = path.join(directoryPath, file); + + // Read the content of each file + return { + path: filePath, + data: fs.readFileSync(filePath, 'utf8') + }; + }); + + return filesArray; +}; + +// Usage example +const files = readDirectoryContents('/local/dir'); +console.log(files); +// [ +// { path: '/local/dir/file1.txt', data: 'File 1 contents...' }, +// { path: '/local/dir/file2.txt', data: 'File 2 contents...' }, +// ... +// ] + +await sandbox.files.write(files) +``` +```python Python +import os +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +def read_directory_files(directory_path): + files = [] + + # Iterate through all files in the directory + for filename in os.listdir(directory_path): + file_path = os.path.join(directory_path, filename) + + # Skip if it's a directory + if os.path.isfile(file_path): + # Read file contents in binary mode + with open(file_path, "rb") as file: + files.append({ + 'path': file_path, + 'data': file.read() + }) + + return files + +files = read_directory_files("/local/dir") +print(files) +# [ +# {"'path": "/local/dir/file1.txt", "data": "File 1 contents..." }, +# { "path": "/local/dir/file2.txt", "data": "File 2 contents..." }, +# ... +# ] + +sandbox.files.write(files) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx new file mode 100644 index 0000000000..e64a5bc887 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx @@ -0,0 +1,98 @@ +--- +title: "Watch sandbox directory for changes" +sidebarTitle: Watch directory for changes +--- + +You can watch a directory for changes using the `files.watchDir()` method in JavaScript and `files.watch_dir()` method in Python. + + +Since events are tracked asynchronously, their delivery may be delayed. +It's recommended not to collect or close watcher immediately after making a change. + + + +```js JavaScript & TypeScript highlight={7-12} +import { Sandbox, FilesystemEventType } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +const dirname = '/home/user' + +// Start watching directory for changes +const handle = await sandbox.files.watchDir(dirname, async (event) => { // $HighlightLine + console.log(event) // $HighlightLine + if (event.type === FilesystemEventType.WRITE) { // $HighlightLine + console.log(`wrote to file ${event.name}`) // $HighlightLine + } // $HighlightLine +}) // $HighlightLine + +// Trigger file write event +await sandbox.files.write(`${dirname}/my-file`, 'hello') +``` +```python Python highlight={7,12-16} +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() +dirname = '/home/user' + +# Watch directory for changes +handle = sandbox.files.watch_dir(dirname) # $HighlightLine +# Trigger file write event +sandbox.files.write(f"{dirname}/my-file", "hello") + +# Retrieve the latest new events since the last `get_new_events()` call +events = handle.get_new_events() # $HighlightLine +for event in events: # $HighlightLine + print(event) # $HighlightLine + if event.type == FilesystemEventType.Write: # $HighlightLine + print(f"wrote to file {event.name}") # $HighlightLine +``` + + + +## Recursive Watching + +You can enable recursive watching using the parameter `recursive`. + + +When rapidly creating new folders (e.g., deeply nested path of folders), events other than `CREATE` might not be emitted. To avoid this behavior, create the required folder structure in advance. + + + +```js JavaScript & TypeScript highlight={13,17} +import { Sandbox, FilesystemEventType } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +const dirname = '/home/user' + +// Start watching directory for changes +const handle = await sandbox.files.watchDir(dirname, async (event) => { + console.log(event) + if (event.type === FilesystemEventType.WRITE) { + console.log(`wrote to file ${event.name}`) + } +}, { + recursive: true // $HighlightLine +}) + +// Trigger file write event +await sandbox.files.write(`${dirname}/my-folder/my-file`, 'hello') // $HighlightLine +``` +```python Python highlight={7,9} +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() +dirname = '/home/user' + +# Watch directory for changes +handle = sandbox.files.watch_dir(dirname, recursive=True) # $HighlightLine +# Trigger file write event +sandbox.files.write(f"{dirname}/my-folder/my-file", "hello") # $HighlightLine + +# Retrieve the latest new events since the last `get_new_events()` call +events = handle.get_new_events() +for event in events: + print(event) + if event.type == FilesystemEventType.Write: + print(f"wrote to file {event.name}") +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/ai-app-e2b-sandbox-model.png b/apps/web/src/app/(docs)/mintlify-docs/images/ai-app-e2b-sandbox-model.png new file mode 100644 index 0000000000000000000000000000000000000000..b4ba6b7d6af52d0bc227164b150525459f62c081 GIT binary patch literal 18794 zcmeIacUV*3y6+oQP(j2(Q4mnEfHak+R7DNFhTcM#(2*)FSU?2<=}kH$)P&wc1f+?8 z5JDg{5vid=C<#eU{H^uev-drB??2W(`>uVTv;H8Nb3VzKBa=Di7@zn1ecund+A6Hf z+{^#~fK^TPsXhR3%me^nC^*GLKe9G$E^{loMSZ`qI6BwX__ou|hf zZ;HIUDSxU!PV>v2tnjP$6Xb#uZ*3HgDqZfj$l2X)GwoUbXk5kkwsY_FdscXLX1I0r z@c6)`O|@5*tYe=~aI@)uZ@V)VVePW<9e?Xm1BUF59z^1?2t;TTc{yt(ty^Ix)*vkl zPAG5q#<20*GS^GlJP#X<1{rjsWLS(u3lbHA9-K?1?0PQITN3a7M;;>@G|S_;Mb-XW8tR z_T=5!q|kjZwDblj?$&A3y{&0fkegThvdM7(AW~NI9%LTh)1x}xPE3<{o~(d;hFfQA z$pTkcKX(42|42_x?1o^D;Ee*&A4a^4%tJeJ{_B#E5-e!R`;{urlQKj!^l?+V>M%R= zE@-{6+e+YaqcAGj17;{Y-FMt(;YE+cYONrKW3hrvQo*9`)pRJQh} znrcz1?GAjdrmoa%rUbjgHCc*Yfun&UeR(1110=>$C1gOBm{Mz%j1y||8zqo8ve(1$ z!#*C|C~4Ga1uME0VNOuM%2oz~VDxLQoLkdiafz46F8x31@VPI1NRRQdQi0Qm&}8y83nyN&U}L}!{va$y@B=^hBtMiENaZJ( zQPfMh_WBi&=L!hY+%JxFe`S}Rzt+u`WwRx9vEqn8o=`rREyfcub$+^+_GVb7#A)0% z<`4m^rW9FRZJZ`=vI1CiQ}3^P=e-sC*%+tE>~PLPTWO-8Kq{#Q?ddP-W85+)QQ8K^}*%K*KN|p+6Vs^1Bza zK1R^*7+8vr$Q9J~aqaT3f?u)04LO{0*3k|;$Dx6D-MD{jKx@lIf}`o*#v~vP$Vr8k zN@q-J*PlJOz8FJhD4lLK51j(SZU1WWgPvH?#`Tfg{kzMxx_D#s0k}F}l+}4l=~`+X z>sOP*?9VQViq{rBUVVC-7Ad<9^39_*>r8b1gsSV;FaiZzptT6_1}K#3q9+G&!v-l) z7U4SC?f}3gk4B1EyYnPfL+sRYY%NV?e2aD$$08H$p7Nte;`u&uZq(ja zb)dWE8S37typ2H3{MN?6KW)mf5L>3j>xr)?+S`mbD7%DaKYFV=TozyAL&$qcYo(G# z_f&$1Z-6XerlC1{O4Y7Q4?U*kFZK-=YV?H;z6c?{6k$M4lZRIJSpZ>`O*ybrJhQR3 z-_s=Ej+Ri_du~1jqx`!@F`tUu&>p6S6I-om1Q|@sx^eB!3X0FNdV0wYC4IE0qN2hI z0L+!U9ZyD!34UH+KE$}MvsKaFp^U6gsRY<=lMCZy*Q~*%2f4#w8LSAj=G$5heQ&=E zPjs2m*iu<7iPm1pG7eJmJ*t~<7p6?FEQ0}nlHRFr7G!#37yN2&-PJCj(9nn+Kz(TR}v`#z_&z+ev1_Kpu)8 zM?3)qUxhyV^H4r5#%1u_4RXV}cqz8_weExVT%}=Bho!iu)7zVC7Bb3n$DWjhajYxP z^mOISYA?8_BjWbjr^b0MpJrAm9Wgqve7ml2W}}!VPMzGut7KiQgl)Ym+ecQTx6S_T zK_W{@wVfDgu3TxLf3-|8+55J)8jA^{fo!^w6~Q1}&e}Se_GfN*Da7?#(ZnuS2alat zt>Rd`Zdoli+3kKD5SEJf%b>4I!agYfo2h%e!2C`4)*|$pe>I`dZw+rKn<8Zl2x}qS z?ZmGCne^WZDgXaqJ}0L?cIQ-{PeYtmRNh@cS$a7WRv3#_V(V@Yz1+Yxt8IfkJ z&mbuV)iqtOBoS;#>fYzyfRdv{jq^A*L{8mA{EDrybHbz;iyJ9arR zC5#P$y1oaGT!o)9c?k2AqEESRdI_uJ)wc%O&45Y=PcE1Mzr{3LW5{m^TD16ZHPvz3 zSfQHLfM1H$KasTFh^uMPDMOA|t~)DM=C@fG>t~-Er*{fNArnhYK9Q)HnF!L$)vs{J zK993wGdRj`Kl5${q;%7BORLd^1+0cQ58~-;$=q|M1e4kGZ?4c6V3#h2b8{stb8G1b zyck46saSghCj_t8_MnhQeg_k*j6Kl@p>)S@iK2AlF`>39kU3zTo7qUk%FM3Aa%|t$ znp`=)Nigoip9lk1FtI%96U=#g?U{fw5g5*$#%Exj&b`{S`zvy;c3_;mhfa<*dnlJ> z;_kPmV9zA8E)Do00;~Xh>~-5&9Mj{^29^vTi&=q;sDdICWlFGVZ*OQVidr4k^g1tY z7F{+OwFA~sCS!onp_`SgzC>kw+8|n$w9{W@=d5BQO4z*tFz7hN8Rj($n;zz@;Ft5d z|Ilyv3h3chF{_2CP*496^@-md{l$Uiy%KwpM>(qo(Z}k3;jT%Wj!PH&a1E6i(DnMf z2*9q&Wy1-w6(A*M;l?ZbNtOuHokNDp)xB*s@T!CN#*5Y;1lef8^G4v&2GyEoW zu1OD{1Z>h5!Zn&+<`MILTG-^7E8l%$Mr|Qq``DCfU8&txJU@?ot<(8LA_@~Yh#cvo zl;0|QUbQ->IdPvtAoZz$Fvq*kPFZW#SP5BF|K4kS!SgZ3l}xT$C|F$K=gH6nu zkP(jJKnDz!(UxOZn}jp-Ln_!~+QYZ;?+u=Z=KrHz+^`Umz)O_2naF0 zu^7IU;3_HGxaDzGE?QH_qSyY^Q@nkAH1M_zmGw7|fC&JvoJ^?&Sht+3z-t;Cr!23o zYKCafxZu=D&e?yaJPceX!w-gAUN5ALEuz`VTQ?pVS#sTUP$zlA(VE|k=Y1E!re)Bj zr}{BC4`J8*G^!|R=a*f`;Pf&>)Nz;e1ScafrRosuS)^zsC}zyC@mCoheyU;a!`rZ@^Za#QL|a!X*k7m zFjEe9g}&fc%#wCXM-9fTlZBBjwoj7RL$c6imlHH-{?V5YtVrJbM^X38r-c-)5|0w5 zERL>(QSxUf<-fdzBL?1aGUoOxmAO9OtnVtLmP1lWQU|DC#8oLc$CKe-P{bMkroEVE z40_e%l`8mcdFViJK?}MmqBMIHTFYhSao}<1N%D$l08IW|;Z${1(2&h{)$Dsb(}H~a z%MI-X)5mL4j@`_jr#}nqWR(u*zySxd@4Cy;YDI#RzBtP{Khy_7ndtz#*@LY)j#x{z z_9WCshO}GNzEy1Z3lxyb>SGz`Wn*osGuxx#!V(^*wFeKyZ5d5pRQGl$+c2Ju>q4fT zNL9XY$$3<*{psw8b)|c`9SUc(mrINIRcX%-&ken41OFv&=^YX)w0cnbjih$Bs@qrl z!q+<_N#AUrZyts$6DAi+n;~^uJ6~8jwMf#s z$pzACBek-uFb#Sl^9>Nc+4Ga z6}A7@U?5SMd+jv*1ThGD-?r|+IEg65T2IWhr93ladQUuZV?Dz+LCBndX$geXu0Yto zX)!iY-$Mr_nd^4^=LI5~lw{X|1CsY)dUDY(?kS9go-#=oVG(b!hF@g6^1vF-&L6aT zkLPSVApYamRJVz`H2az^P6`5Y&sZn-8R$){BB@AW@5^zvu^CIfPu_d0<8~AJcTKD8 zKe(w7LztCib%+KkAsVG{fZyiNHvJ$h35hETM9`dtFPq+v9wr#kh=G~mBlG4Y z*ic1|E_|<+vzRaZGUG+Y))2KX>HZFZ3iLhHp>g{6UA#X95&Gy1PGgxHf_ym>_pMHn zb%|8CSy*f=BNesR&RwQ9P|h~I)MxI2ayb6=4V$7Wj877OlUfnXAdL)O$Nyq_lL?r%$v#5s_x3(`_*5q2oL9+&}Ae%Inw}C@<(| zAcctIF^iR!l(a{}U4nOqRQ6KavFlUKZa-giADu7XD%kj8-m;xiJP5&PMn|4;zjD9l z-G^W_``KaTcR-^OQC;Jlp@$HcxADbw7s7d???8UT&NE*Mk@;+%@8h1>UEawISxZFZ zwywaHBVU`2`G?;OuV~#EwGzp89H@Ui1J8tJHbFIzqTuJ!l&am<5;hwr9|7xLcDQdp z(;Mk$U(&x?2%clS#dsEaq6gft7PL|f*UTRo?U$Lc@Y9^VaV6~n<1M8hkZ)SVBb`-< zx-Q0(dYhADJ(&4*Q^ZX2u}_h}F7DGN&MK1n3p(dl-W<=*&v(qj;twqZZUna8t?Iq1 zw1NVc=T#)uJ+O?b!yHRK_L?(Mc()+BMg&#YvX=QytAqWiPl#4ZG0L}da5<4Plsx+k z6Us9!PirAf23cOvoGEfOCbHXCef)^c6Vk**@brSRGv;AuJ9N17Q0FRi^S;c}*Q=+a zxgqxIu^jQcAcoSk@{^KCWOzYDo{mm0lG86T+#Xf`FoHrwa8qra&?R(~~M zY5q#R`zcc8*?zGV)U5bGHaWhU|&#j#auvKj2I3cSC2?#=6|Dn+b23xlz-n(tzLDPZ&;0vHvs}5tqp;z~%o);;dl*vfDChAa%jMJ*Svx zK_%$T?8;)rdA7OFn3HO9Ul-wrxT_qMg|=hE!qbh)%^b2qNe~`&_B)fZx3p%Z?jI}g zt_7+S5+tVC?%528p7k zsq)Y-SCz!x?rS^-UTb$#`{V!>W@Igo8WtR}zGyCWz-}SQx)@sr3Dl)*s`O93*T+ld zuF6_m5jBhR>Z+B1ERGeELN3;abfh7N_xsc*Ce+(>Lkyw20hWV@aSv*^I2-fDqKzQ^ z@jyh)`w6W|DP@<&kqFq2s%D|(Ow`nxS+!DMYs7byHscLTrO%O{WvYWIDR}-( zMX4o4--nwiOm6SPu#S?%`ID?#knlDEVbP^MrF(+zf#RZ9gzOJ+EFCe&;^Y?UY&_kh z)pH#Wx91(!AhXS*mJgZVHo?#X8kj_J^wEn>zl)|zpPkJmA5dNVK{@ODK-f*5Lgf3Q zZc1$C1BjozSGJ{x)X}QC_rlIEuU6$-;9J`ieJ8J1UE*R_8axZFa{%W?Sq=vwPl5TG zJkxhshm?IRG2pw%WeL$>e}-Psni&pF_;}|ke{!sI_@GN9vi{o+V#C?orQblw!UgtY zX+=mCGNQ)N>!w;Fq?iexTjvu}9S_=CIP{xLW<`W#=1VzJWF+?>Di#lz6N8f-rMa<8 zDYD|_HyCma#N96HQ(B)7W({wsJrcZ;+nGhCKefiZYbqV@m!|}--IyF(#2||6>O5xL zV;lYAKj{Z-p!Qeqx&2rsopT>3UObXT++e5}k)asObjae*7~phyIV_DSt_ze00h`vj za5(%|CAenXxt6>!GhsyK$FcM6JZF#J z9^H#G0EZ*>?#7cnxxZse(`0>1dXGnsH54~i2IF#oUX!H4OEadaL^+x*5!y1pJOkLi zc{t}R8|sLUAxD0$3`Nd9^%5|d8>0D9WPXU5{EpGIUE3(|yeRS0-pwO#4}R=N>SoYM zaY@%^z&ojbEWBHp5EQdau-`QlN^RNo0I25kb`bw;k4Y)c9Ekk|nyJ@M{FlX*|3!)a zqQrku;y;%X{V`fHX@3yl&uY(+Mx`+Iyg@|8-@i#|#DH(jmu@%hAVo%%e69<16Y4qY zhBRrMl$TqTtNDv*SB`Tk{pIJLd=#?Tl!nlA09mBde{zy>v|EHOQ8dafF;@Q1{d_ z*sttSfq1)-(sM=qX|QDnR)>Jbvmj-TWRk9F5IN;ReD8a^aW6CbXiHrFXtQH(bjH}~WuYg|(m#5Fcq?x*U@kg*t~=IP-tXpV z<8b=VMt=HuBY7%CA!tw1_dkZmNtSP8-%MtZ?E=wYiPLw(Z`>UzOL+UCy|~SG%B(vO zS-$#&#@cDuE2#a1qTa6E`Lbz�MJNqSI7@wS6q%^Nsh0yWsAGPll?;9896UWo9(r z>12LR@bmk52C@k6_Mo^Ec~#^hI~xU}aIjXBk~5e%Re57~+?!%&sv$vR5}Y$0gW1HV zOFWO^wH!+PMcJS62n-Bd-GE3=C7rl!t`i#~tI|Drn9hmWK)l5y$-?|btnfsOpp}$n z$J)@tHS7vH<~c-|C0Y|jUT@}z&BTGBQJ^%eqD_xXkyfht3bTnhp&L5D z@0_%fs#e%+T`Q;z8J8~^NUggwSXhaZtJlf^lAP(POJWAI59K^93&QTYxbaQpj4#w@ zGWs*bUNhg1d)_v%f^x3nRxy`VK%4e$z6YLPw1pJ+#_Vogh7_N=n!b*&bIV{ob%$h$ zu|;GlN5Po*Lw5CoR$raut3WsBU0uA9|DaBkG2y00@|d5&4E$=rjsYE~>T3d-txvM? ziPRdG(*mPQ7D>pucs&J-Aj+KxM&iQn)DNh4TV|y5u|7$egPk|erH4QLW{Rlb78BBm z%)0AKly{L4Y2L$D-ZC6iUrFw zD;*o)V-IT5EeX_~CAyUVTnACV35a)@_AjUs)jHl3DijP^!D{vAp(>bM;xiPQ53&Qe zEngDK>s`YFHrr0F-DAAK$cNp+u@%R#u#^y1gj>oio27kOlX*~j=I%Z!|ArlZBTdyy z;dUj9^>EphYB`-YjkfL$bc~QEq@XyC==9{tlfA&E2u?)Q-=Hz)MfY%#PLq}JvfM5w z^2lMu8!rjUzy5~j-I;Bh>oelvZ)$$z#w9tkjBq&lXydta?Mup^+Nk8Kb2mcX9s|y> zE{+Oj^2~d=R4SXv6}l85NyVS?tU32AZPc!nZ8X<%^}*A2%75-d7QyiKnPHbcT$&bI z1ch9Aa*2EDl*#>0h-GzKj@J2#TlbXM1@8)Z9tb?b0xhxvSA;NvwZ1$3GAX>E2d7nF zPha)2`J~%|6lfQN(l1!lxtfj}d~VOwd8~`uoY23dKh$F)z@V}A9{BA@NIAsQ+Q+A6 z2ui2bn6Hnip*jzYV#4b(~;;l(QhvpLa)dUCoGEOa>P5OhcYlEDbrJEvvHB|^T<~Lb# z_0x$Nz*HYmt=aHyDek1C*NMvU&2`6;Vm?^KMy`X#_``)6pD?x=L0?z=cf&~M{&Xq7 zrhZ<`d)?CDz47PLk}K)CW}rZ9Lr6J$!Q`AXJ7T?+>@MeQ?51U;Y5wkPdaE3*y)59U zGjfrXETWmEWc`VstDRhUHUHdf-Ho0qbkggH(Pt2L=ZX*I+`-IZ=@C0B6Osx=p$GYn z?oWl>(sliK#bP+idmhZ;(`vj|4JfT2CR%5|8!wX`3fJ5Ut&3Vqlmc52i$|(g@GMc2 zdMQ9~O@yj|vHzr(3M8`pyjfqNv}80q`%XU-8{-uYnaJNxHQ)GOdFKPy0}+A&Qup%; zLhlqT!{v0M_NTl!pu6fUzq%zXK8&s{X~fGQ*J}l?=AFL~QtY*Fm~wj%?f8lRB@}JZ zF#LL>Z1&r7OVL)vPasTrwmmS~01~JbWP14QRUy9JN2dItc!#Zj^XTee74n)l62zc} zV}oB`>=yyk3inR7=&&~FSe`v9e9S|S*k0BOIeh#CWM;G3qn>}4dYh?JYon0yWcV3c zpv{=x)fe59(q|C;K%o&4aBEAMf@mp8`gVxnF0=1i3^p4Z*n$ zb>ov0UeT0S%!SIplvO%!J5q}#vAoNLXGccI&xJ*O%zKw6p=!$ z({~1&TT9)_r9c$V@-*fAQux(Ez1#FpUMq$j_+-U22Nhg(*yzkyobWQ2ZrJmU8BHb5 z{1}7tdd&*zZkwi$I~nj;uC&y|AI*wmH74E~pvgS8w`__(z2yvAznvXyJ2=#p-dkg} zQk&pum#xzb!{b{+niUrCYRZvQiJXl|y%TyxKA_?U1_Rm}6JH6cCC_|^A?>DIlZRUi$D@J1R%Sz8872AA_e!yPUOcu< z(Xy00ElEnh0?%5;!2SfrG0Pn@SQD+);Y}Q)E2ByqRv`1bgLkyX3iBot0!%p3ve{K6k56ZMg zo%>@@f}Nr}m;Q_FNUe^a%-^x`OVbq*nbejTUO7j{!7R6J=P4ZznJMEC_^*S=Zm{IL zY1)|Ldb4+~X-&?=_tZUBZ&EBc9h(vHePH%UVN=H-wPAHKzgwx+cUPkH5Z8bIc%Qq} zRCTKzvT}co?Hm3SxtQR=E1Nn(X{Sz;-!wXEZ?}-viUu`;5HkB`Tt%^c2?C`b)4bB! zZuspc-jm>$>Jd6-6eDDzl_`s*3!_1MWxW#N$wO?^PbZS&s^-MTcBwxDF=%_63;K0q zcFdx3Sq+0C2Lx!Mzu~j16ZA;bXs>dc+rfB}CKCyi?E(xI=AnW8DAV6=%zzZWi9jy@JvX?=p_ zOX@0K&df~SDw@TZKCKjJql88dTynM7z|Y~!CFN`Cb2=(_L>he!urOvh@y4+jzlY2r z?!VRZZ6Jhdz*S+oq*{{*o1E-19QD;QyTXqsF1cAoc&%41JtDr}`%Lf43kM=>Y7g{2 zdY1tZOtUU>1|`4TN8-T znvxh&*dc`D*al1Yu83LC`?2%m30oRn48ba%JwAxqpPm?2+WWsrkpbBMMT*P|YNZQA z`kTW#Q?x%iP757Wm{L_KGg6K}gO&%UcEr0}U&0RphFtBWxs*;?)0X_9r3aIdxjVVf z9y{%@2~S);D!*3>b>W7EvW6l96oUF8ou6tBvV}V`5vaNKU2!?1tHWG2rP&hvLK{fL z>s9mkz zpa0qRM#~Zz2R&|?Vr6m3WEAvZdl;{5W1m1Np7Cu-+J8H2ahX6i3@F%gxy1ncbRr_% zH~y~P11Xa-bAri6ZBob*IyXS%awnt+tTtBsKnG_rW5+BnWoqzoP!j#S%MSu1UoOMa^ugn){; zKok2C>?Rzgw#H^6n-}+>&6vvQ~jdU19E_2-Z&&ZM@ z-67@Fb+K*nLbw(BH{D26*o`#Ou?xA)R$q(l>vu4D#`iSt=ljd$~M(Mzg z*UFiAoLNC2yCb_M`@!B#2AAoiWg>lVcL5B!k8znHHj^0cS%??96rdJDRPIa+OXd(# z+EZXwQzIgH7MF@!jpNl(v=8t&Sp9ThAJhAj{J}r?KzDV2>hVIa)vq*2sr);z?A13H z3lmHf0w^5*PH^z$$Z~I-Pac-StSqOl9InxS>goV!Q-5=djI?96K%%LEPY6R15fQ6I zA68KduJF>SX8(!J-!TuHJOcYyVh1qXWk$pPOLWgl-^gMO1O|M@By;xi?~bRfVCIvM z+$RFUSk5BhA4{KWq?CIN%s;fp0FxwNU`{c9Y~>j!*OQg`HaBV;UgM{Z(*+Yj*PgYB ztTwmDE1S&tyND<2NGzJSZD0n_+EeI4TryH3Bh)kyjD2@kvgv$(*Mf zp@O>B`ad^S!Ytl1D-cIOFg<6&LWYN!9L)1VjOK@93H(cvov=Xa?LEnx4X)!=RYTXq z<+5MrAZF_e?-u06RRWJC4 z%P0AA*t&#M;g1J1%|!vS+&06tlHpu@xFUTcW_@O#bv(0yyH?U4$V`~wkN)zI+YPf@ z$Rp|+{)>O!0~RW!xnI^N?5ExRbr`WjoJJby>FTHUD(5O^=Yfif{9>RML<8_+NJX2@ zg*#5Wfdcm2_dw?iyl}cGT`esP`dKB?Ln-K)d$1 z+;v^XL@?($tGM)}pDyfCI>zZdoVNzg4#h`Y2xqR3QDex9i@Tgz`l-^fpIh$ViIu+n zx(^Cd!Y6R*kH0Alv`2q|D45}$jL-aY0JF5lQBA?y5~|5*0TL#j|&`}FW`Vkqub8vX%jF?754_TCk@va}NsBQCdR zyA-qiv}$WZ$bLcJYZKnawg+vXp2yyNRWNc=VWYnEKM^p0IOfv*I~=i;U+7!L!zAoC zy2qziFMZ0%V6l+Ht)*BNf2rDxm!tj~Y@!Gwj(>`onXDdaT@FSoxGgM8Q#2>WB;}1` zr-1p?opq@{F5G=fx>@>Ytk7 z6edZkvibY=CvdRg**|$N^ab+&wzQbA(>UMdPCWv{m#1{^W~y!!r%wimj7t*`FE2Os z=)Sl=9!SyPG%Ek&VRhx@XulNpVOQ!nfa~p9GTJglyVx|!n(->zF3p7TIN)MWcpe6N zl;@}rt;?%Gg(TJia+3a*o>R&6PtM!_1nKrHIX<&Jq|d=Kg;`$}W2w zGahCRb6wGN{UKXsP+|Ww#F!aLy0G5py_lY_5{vJ~z_hCOO?}who0e}?J7e$c{7%qG z9sr@t-5U!F_xX$9wC1ie!Qzz0AZll-=mtB#c)Hv7gK~Js-sy!BcKj z8wa^JXemdchgQc3vTcI{`5gJM{8Bt8&D)^?Q|mvONpErk&aH~P5o8uOdF9*dgcql@54e??Qd-;j& z9c)VS?v#-EBx7d(DPLTJrN{Me(K6E}4?>RuI_+qDEp#C^oIXbzw4|tQIv)f^AMq^F z-SX{Us9Fb;^J~#PH`;nfF?QJlL-+it z9L5$lQ2(2s5hM3%^Y?}ki+B)vQmT~L=Yce$`O0gUn_7eru?tiFGvxuRf4L?vwBA`a z6o$O2SKRU&$HB*Rx_vFGzlTP;FVsiz1XpE)TK}kz?*~Wg`&3L`QN)`T)5x$_GuTHLRAOw3J_7=ssX|&n*#^0>t#qJB8 zT9(Ixc!{FrS;xlO-kj7}qX#Ff@>d$ErRDYpgOchgPjYbjBl6;qrwleJPbxGv8q&d86Z z$-=%6Nd%-!4WF}fJtuXS3?ysm8ZVidEKBI9Gr4i60*)o1w{ z(I-S|1-ONF;HQXfuZD((B1z1iP3!dg+w%NX^W1-omgQs)2>-C5H~e_C=5nQSeCQo( zsp|PK*a*9;4{NlO;e_^eb|wXXcU0W9=)22i>Fq4BE|PbI8HE^S{oNSv@LojmaZJH0 zl(>m625Zf>Vz*^LXl_{0=sbrU+|Cw)I}F?~E)^6M`fi`Ao2xSVAhwo0WG;&I`cAVc2O0-0Ux>p~#OCh)gxPZf)#FM#CD< zKyXqk*a$yu#2m3wO3Lph1P;W0%|%u8@cKe()InCvXZ{xn7Lxs?PnkibGy3{N?(%Jw zpOb-1)zQy;t`?wDe3uDG{tY{yTo8Bn%s=8?v|C6b$#IC zsN$=|(u7-6LUfAyv8ha$J%%Qplv%H1Je1MfNa1wlH#K}Yx%PYgU15!G-gyBizRyEL zK$bfb;xoaZm6G|8OZQ0VG2?BS+Qnn4_@#K*O^)G`wYLaw_R--6YUu{ECcampK+1wT zZL*TG(n$WvxjgY{skYvB|M1+x`tydJ7QFsYJJp41{6>1%CQ>fu`n!QF1s9lhrt|hA zhBmGK==o+Qj<;$mmCb+ig? zf;jW2nXW&jNj6*E`MbYY+=#|dV|0Le!^K@^8P@R+Qu0`@LieukeNqX#rWHvBP%soT z``7j=ceY0`*R}uMl>C2qwTb`g5*xZUT^}zydV2m)c3RY<8V$5&l!)AY3_Z^5*5j zJD=%R_6mA!3uP!2I@=Q`z&PYJ*Wl2@wie6G_c@jO1<(d zhSu!)n}*k`WrdIW#>bWF2kgWOyQh=2b?P`(VCxI7nPFxZ`n5>?Iw@&= z0kJyA$|Ic!o7r2Ncn;;0m9*8)mbck!-76X2{Cx{UoS{G$dT57lFNeYgeJo`=CDjQ{ z_7oD)p<9Z0d)B8w2lVz1V&i4!pHX+K@=r?TpL!P&B80Z(cAsZvCQl zI$6UA@loG5M;~K|*@`l7G|At4@C)*CZJOU&uWeIK%~acP56XZnXO!iDid1837CpDj_3 z?K|W6FJG>VMK&&^>qFbG77mG05T6!+Ron0BQaa#M|2R})L8tZZ!pOU>qZFjGkuN69 zR8Vqltg<5}Rp^1xBO&V#F^%2p{xZYKi(xk#Ew2LqWU@0C5}#$Sc(Y6rL1-6-M)RlB zM50C%k=i}b9{0Qzd=Ohs1I_lN_pwM&cXjUIzg6{2iEE^Y)kZBD1_lLbbeD?0FrL{} zd$L7XET>P*^cznz|1myRz2=rWOFyxh6Xh{p)yX$g8B%(AXl#zs9RIEqW$-KnjKfTI^V(X{$&h%A$t zq#`9{Wz9&agPp1y29#z~^tyut4Na4g*wB&Fq^+KN|``vt`$pP>7P*8WufQq0&;94wI@VGESpBO`JKP^x*c1&BAYoq zKv&MS6x`LTxTCd;3u@=H`sDr;?Ow=GwJ!%g=>9gC1ro+3b52C=_Ng3WY9* zgALC-UH--n|MA&Ls@W-7KDBdvVq=JsePU;2W@%^kOpnIF(8l(er3EJ|FDoZAjj^4b zl`TIToB7`_V70U{Vr%%NrUVx`Yjy9jEeb{S1o?}WDw6UHg@!^&ONc2u#V*DP8F0Jvcb9=df)zsBGJ4%Tx6T^i~QwbXXLvMwx@%cwsa9i#r}cr9}d5}wRnNXv|&SC!j;5ejF2>Kr{vAY*R`(JON!KOT){NKL^i1|w}{^yc3IC||@ z|NpuK`PT<={G{GARl4jSii;mF)k-_Py26M4@-Bwhxg5`vCbr6jK5XY zzT`_6!jhk#Uv#is%3(gp74_i8+?ERo8JXVx=6umw{pDPTC3W67xqKqqcC}Im7EH0K ztv;RX?L^(~RE2Yx)eE83x}w(B9IO?)dWS2XCzoH(3OFpPJ)m}Epb4UF72J4$^@sTjh66qtK#md88B#8JyK#bHoeFg(tfJ+T1*;MJ zzKI$8a}7TVKp;Lq`P#1(hAk;WLjNjP9UNCx^2l6IQ(5 z%PlXyyk%0olif$On_Gt)^V9E3RtYYwuW0}G7wg~MjBdLV{!VLk7uSBpSSF>X;~s1; z)wX$Ta~kKX=My=qZ5*w5Qk(W=)eYvGt__-IPpnSV7R|iVK%qiKj(H0#M$*@bZ(!@! zhg5$I6~;xW<(rVIYiPJ{J8yPK!Bus17yEN}M^-#;_xqn7fWn^#a79Q+NUhRC2qk?* z`u_de+hcCxI-+Nux3E=SAq&Q`x3_nijdMg_R@Km861b_7sm`tDfAK=a?j&9;zdbI0 z9HG3(5m#qdm-{v&6I1Pq$Bw`?dipO`z7jNc{FELi2V*U>X0?6njSSAD1tQ5Q9> z&`eBBtTuk$b{#1&YNI-wyjba_@}&-st;{PTg5>S1FmNeylh+KAh?(#m!)<^3_z`1f zW`_4*F)!C_;1;UFBJJp4NBkV7fq_AlNj|n)+2g#Y;Fe`zw%S9KglFQNe_e{T?|t0( zxYTR1UYzz;hHZ`iduMY#&+1dFzI+~)_9c^B)9BgX0)vk)BKnDY_7p^zVJCiwC_&X7V`1-s1rso8OxogPj7&4 z(I>dkuJjEK2A!dD5^b%Mfqi%pBBIoTt6$Nbnk zHuee`Ql%j36Fj>As+Wk8)kiZ6MbV zao?MX#7A+){LDy6X)qnz+nD7tuGoKbf_K1qplpeS9f!5e_+-t_cGR5gknwHWGo_;E~MtK5Yfql$}yK%>a&sz!wy zUyPvhtuB-N#T1bvMvN*lR?RuvN^s-|LjwbLlo>?$#iU?Xz2J*%?+W8QkN1996f(Ii zUD7v$n1qkIFC(M3wYBB3b4kQQ5Th#IE#8fYG z6WSTJ4eHwgi)xvjgnw1tMC!@&hL#q;wy=hW8jhAZo7Dx8E|zVy>Pt#W;-kK#r-$ua zlzgM*x|ENP>YBGR>qwF`+gqPmUx*9~s~L5krA(N;1V)chWl=mshVAt;nmagCE!P{_ zcK7W8qY#dI*xy)oO+~K#t;p6xrL```O97P2>b_nzdw(Rz+RC znVAf)bUN&QKRDyfzE0n>7u3YXecY(O^fcSp*hJCbELJ_o@Sxr~K3FkA^%LA4{;;dI zyN?li%Fnf!|FK~wDmDH{T%n*FVXnS;LG-ml=-UTC^XpC7EboK(Qath<(GWQ1tB%qJro z2WG}SzIQys=GlbG>G&v>XWPo>&!STii|p3?mJ7C*7JT>v63OfXreS9q;N$s`0T58u6g3pfAbqW0>bC!E69@rlqO z%gQ*kRbsxZihUDoFZWr2u{C0CD$he}Y_FG>Z@=QZLg*}TF?sjmx4}X6%C^1jAif}rKK}UN(L7SAc~0}+kpS+xQuMieGF}G8`6nL&&)J@{P^*MbC}zG zmB(-S;^g)UK7YPZVBA5A?IpB3?&A^4eXi@XtUjtAlIL&Rp^G|hS3R%JCi(Z6yshjX zv+I)8rtN=2C)E$Rf*j?rQoiFNMCK`b6lfj`#}tjGtKaa-u+(8`y<`bul;Mr=Kx8jg z$HgQ~ZTaKO08*`+^1E)EZEqx;#FoQpEKWCti>*kr6nTwD^!1mT>TFRGqkdH^x6**oDb*JjGD9nT8 zfbC^IR-v_)i+Le=dwHbgn>q_d6`+aV_8On^&){6xF$r2 zoZeoQ>>+K}CGOtN&Pm(F?DB02@Hu8Crk4AR!AIJv$TeS4i!A4}gqcPu z7M;5dyYRVdK1w@#Cw*t6)REJt8nM>{fRGFJW3Y|6U2+01(R7i7S!OZx)e!Fh@Q_>l z3V6ZS_MK*?Y^RZWNyg)S%=02=y=ek=|H59@eOiuSRqHKmJA=oiV@IvoP8}T`)ryLW z5FFQtT^1b#TAG@kpwtWvlgr#!M$5q(RMgZO`T6+|sT#l-8&Np~mw6h81SJ`lRnA7b zE*JZw>3Z(9=#&-MuFb`}F0Z*(LUupU67eiYB1q-Vm#nO(V0g^*^bHNq&xJrvYr{t| zv9awGoA;zY!bfQo+a#AQfoIZVRN>;`z3(yEDsJ;U-k`?zdjH@?@6ZsFCDC;mutsDZ zs2ua5g1r&{zPp|i9OU4Bi{5ywuiH{)6V|30^2Uz03x%`F_V--|I*8}g_G@2!q>p#1 zndMO+8Hiw1B1dhn))KkG&V)VsqO#|%$?9M&3d(COlcu z7KA&xgG3b4i;Lf1r>E!q*fD2oK5;lFC8CGwhnqC2GoA9D08n$?5{@l+QBmp6r#|*% zE^h87JzCWEg3ig{!ZxIGI3yy^U7xXojjbQCd`fG!6>xDdWQalK1+GDgN1hP~shXs2 zJ|$Cr_=Nr#h&7;g{fu-VxVO*S?LwZnnr&S0;1qI^zmzVwP z>+fFSw_}*&aQ$jCBSZf3uCj`XUdua{^=)vD;od~YAp)&;fB#d>%xEkHYrxgE?wqN7{U^(f_y_GQXqnGp~@lg zxSem`xDZZ6=ufwZhNhGvSNH8%ms>%C!{9Rn)<`IPH%f57VadkK{2li6`S!NMA;gQ# zk~W>=^^2(2^uJ!TAXl6XdCW}4tX)R#Pe@r)V!yE3qI2A7I;Pgw+(7LaGCHcwtd=91 z_0oze`}1dP)833~dCz?%H(&yh*=VlYi)iES1Pn|}K5%jn^j`w5C4cnjkyt3pps5-I z0P9uw%qw1Y<)s^~0y9Gr3K9M^nCX=O@UH?J1B$uYbdWb-)}QkPW4ZFgV;Dkn(S+Y+ ztD~*HDTpBgsFl8Ckw_g6=YG?xU`5@MDcfiWLi1G|by;BP?&(QPO>Ly-Xab z>b4;(2)WV;$k)sef`<`XKxh`=4?0W0KC@_|$CGV*E}IM}#_mE-Cl^nO%a`2?_V6aQ z4Ip_H9c>SFjEqoPB>gZ>ar z^x3ntzKWx>_M?>tBP){-87M^H0zHDpgwUJ#q7 zg4rrWwY9ZHtyxI$$e648bM?{gE$kj{v~>&&1OmC&A1<=C(L&G7COvkd_Sk*WAG$N{ zLo_+zPkmQMN2lt*NgLzAjSKOf$IipRz>6SNS&g~xB!2jSf(%s~cKyE9R*xzj3(L>h ze%f+B#^)kBHa54usb`jzgMuNv9Tpb$I<#wem^s)b=C)=1SHl)7pln_Tt`)5D)4zUo zc8fp)xQY{~h>-Bt&pnI3s%L6@pYiv!)&a$W%4P2AUU27oqxe8@tSf>}=MbVf-CQi&XydPSHR%KFh^XY(@bBUC3kM zx_u5T6|@b=`xGLF6GYYIc>85XXE&3hvS)&rvT*pMS(%uaGG-4)cPjh=M-a1>Z=Oex z4DjNXJ7ejOzF-@!lj`VrczCp*wM4y+i=*7ykd5UfhQyGN*kQc-{et{BNG*|)jNCZN zrib>AzZ#qc4C*ah588&lhvw0OBYwhkh17@RXMh?K3lTYzTMrHm zS|)YNni6Ae;7o5x1X*lw90cobi&(2i!=-me(M0M-CtP3HG$*P3RR`+=-O zy;6B1EGMwUm8~DVNkK*se_{QQ4|Px*7Y_155g_D;Iy#}3EsD^-sAkv03f{!W6K1Le z1Nqbgwu6@avO232PEq3UP7(<)d5&wTnVEGE9|%PE4Ua&Jz%R0tl_lV@7!I%mMFw@P z`q%zKb_1Ko8lK?E;Rf%~W>>Do2tV%?LQVUgM>%TD+B>tA%WP^nD0$&Mg9m+Uh(Z;@ zfzV2A7Pc#%EOy`>?Bw`417^GcR&K~fPv?bJTCaM2dnfKsIFVJlT$AxQFG<)#zE$|Z zEaVa=wp1up9nk%tV%yotjW!W~l`mU+x0>V54OdSPjfRn=k~UKxY8o0EK3N*ff09LG z(<*Y}Cb;(fg0YE7Sm8@@4s;ZVa2}GO)qPEI*N=x454Uh;=%AX;*dKUEfv7O4bFzQYjz4ZOHVEr!-X*rm!&}YG%~l9;1y+i9 z7V3M2%I=hG6#LbThN-1YB9TLO4^Uiohp94N_L}jy7LUor3kD*ZgJszoHUeOZj~r>T zpCmT6w%!G|b8&TD^A|Z3%OyVq?IE$Ef{OF$k1E?Xp;=p3-laOk#oC|WLgdVVtJR=E zO@Nx=xU9+k?4kddi00h<*jF2f!Qvk~5Oq;ZUS7VcR|r)!?u~~+Syt?QmLHY=27gei zD{{H&nY#$w%M$_;zcJf(2358@8SFvrh%n^Bjr>)%np}x8`xDl>8O61rMhhEvh4zSX|$VeY>oei1%HwNppwQXAYHAA2> z;1m57?gBS&-n=7x*V;OFIDS^XTQ{U>s11%5OKSNkP1^wokh!iq770s`pu{94v4AQg z5@y0scFFIXBqSt=LpIbBiG)B(*93~hz|0&nzcw>H-FT;)`grvW-wso6z7236(d@n{ zI5II{fs+SVrPxTQIocUhJyg4X{kjt(C7}cymm>;^rn#9()HBIITch$?{T*7#syV#W z2H7-8gcnE??J@bGnLVNu<0RzjH{3!kW_uo)wjbSOVgf1%aE*e3qRc|0%!vb|%40n| z0Z9Az0OB9>cKhzJ;4OghL1%m3M($Kk4yaBKbX9#&^41F;hEI~~gGNCGOlNbxtNgRx z*7o*S@Jq3HT6@q#okvyx9=%QJG9Ucbv`~N$h4rI-ksZKN@9XrQ0QNtcAoA4ZiTODj z^@>WU`FO9*6I<|?uCl5sCvX#B?%-GWUTrw=!FlSL$f5uSgZi+ru(08B3`CL>wK(d! zvQ;t$s1|M|CZ=W4p>#}tJRH^V@^XXl$)RlmqTn3>oORbO6h$Px#mQi{r$D)=YoXIihN~Y*|(fNRHm}U@g@1 z2Py}&%=U$&{@z|h1);6vArf5ma?=32a)p@ec0>49eLtJ$-hFJZIKW=oLv+P{FEFzG zA;s?x7q}ldeC}I#3@W2WsYB-2!XhZLQ}&susj08Ct-(Ck26qsga{;p&z~8*<@hcy& zk^s*?)ZEEExnj6Y$uO#J zJcz2wD*i>WUB2QT3I?mCeQ>yFBoZF_WPQ5n)KCCr8zD=|Q)31_?sr-WN#-m>jBx4} zGoHM>HsKgV^U<>Fkj%))cu=tf5}M)2$cXk%{(#x3=!HVGG>A$@h;%Ce$>p(v!kf^X zt3k8}%Z`;TDE2tH25|H%K(}#up44DsdjT2B1O0PomRvkgF+>`D2}A;eCkvo08X(s= z-9RW$fEvWi#wOokS`($=TQrvx+#kiE9|c|&sqMm83bNMp20uuoDmpsUs~o=<7T$vf zgz5)!MrDqLs3>%_|cMLktlrI=PUP)P={oQsj-09Ia7cc1a^g7wx{R zELbR<0^QgwaQF2MkXUn($bj5A$Z>hz-slA;Js`^m^%+3)N8W=7gQb%}Ow;@w3tQT4 z)oKQPIaW9~WH{>knX=1jfJuWerm6V@No@{4x%+bPSc|+!FJ1(362wUDonnaMGgCsa zWdi`KAP`)-fcg9g${+Mdjf)oT4;?7LbvJUGDXZvC$MG;9m-VDX_L9n%N5|{TIOqZ{ zo5t-8){y0(USWX1b3`ab7&a4A@Y~49JP1_J5%okHJ>A@d2b3gBTP(HU<+j zvjOBx10W`0m2-O+k|h)jfPg%KM5cT9;~StY4uI#u1`a~XK`4dDl&kk*Y&Ii1+o*E4 zj;$Z^d{mQxo=bT=+*KY3IdMX(RTv&xR5E+ua!j60l~b<-yq8@kzn^u0`b8dxemy&= zaR6~+L_CENTPqt@ioYV_5v%3C)sykzgV(%WiIC7M(+vX;zXf^+yx}rPr>BO& z*(Uh$Uc12qo6K^c!HcZ|D+U0yb?KyD8NiY+y}Zk#_Z`Op%3e8eyzc{(=5~&g7`_6o ze1izH$i_fo$psw;30%QPAX*!hmzN9gI77|HP~jRQW8m9}h@6G&%J`+R%CQw&2I6G$ zaNoeOqh&`kAd&0(7fDERK-S1hI9fDX1Y=U%jApMdGs#O#e15d*FJe$vSN9;hFE1?Y zJc3F3?;oE1K3r^j3AGKy3avHU9jQQu87tm?FmMpYfSS6FkXdB_Jmi`|C*~240V0Z2TO%{>+3e}qNAH3Y9Q4O zfrX5`et?S_4!f&QvX7P=1P-8>)P|tccc2L0;^Z6vUAYa?QMuRTg;N$Ge))MWd&2=j z7%_<*Gt~2O5xJMjeN$oBx`EP!now+aX1v-5;jd7#0bDlSTBT%nKN2&kWIUXo!=dHc8S@k&*H?p_coyL;m||YBr~h+EoT?7M z2z5a&WB|0{=y)5{vtZD~#J=?C0oU|MIeXqW8iC+WQ!j7lK=I5CAXj5sTSJBWfo`r^ zw=mafaasB9pQINvF$4scL@1vjR0d>5C`7&nXM+Epy)J7MAc{O-xEcZxh0gpv5IQ&{$<)G4h=i}K$e_90@G!VNO7#S4~*#CIRAOHH{)62(8SX*0H z4M|5RdNmoK)09WS;oqc|oumz-H8C|+c=+&~vh?);wLA7wsaQQ!iP*}Hz7!8fh)u-u zrBcy);v^v1ft+t3bp0HcyF3~tB_(^zPh(5V(|GjvnrLxk>?0cPC}io zN0>y9TpYn})tdXc-OF5~2X7^Lg=`u*x5M!LWqmeg$=?hhq+M9~!~sOSo*|GHixKKzc) z7b{2aurw&Cgc~6C0^Wp|E_8-IJYg{zdVLZ3pwWpe$wrKMy>tnVNGzb?4P zL_tLbJ5%M$cH+5Ood2xyk7fV4f*POCD~w*BSN{8s8Q?i$aYFyv=b0LXH4|2;?hN1A zz5idUW->OraeA)m50{8dMBzlxdMFdglwFa7W|TtgT!Psu2wx*zy}kXJWL8rE-$%~G z9vl;DGU8cYNxz>`8mspC1h0OO{h*GSdURV^^>5R~kkaH!hTZd63)VrTmV0t?cb`3D z^Z><|R(Y`p3ZUKqprD-sshmR#L}r^Xq6V{@bTfd+_ajc=B9d%BJUZv|v%Xn9cCArL zE%zy>$9kt+hFabwBf)iI9+lp7cVmewwF^&YY&F(q&9&6_hE=jl5=;K>5+PTcyg7FW zMG0;y*F}y)h_F>q8OSvs;z1M>M3q`YqV9@&dV2apZS7Yv7A0rLPL6lhKx3IiTo?%5 zi@M;87$|LzJwr{9M|X$Dj{Ojp3Z*|fquYY7aUKFl(9zrL2h|*O z6lg5Le-_FyQ2|K-kX#UIj`X64Q(X*H^uf@_mrJ>zo~hCi)5mxV+1pg}!u@hB)N4zg z$>35lg%;AQ7t$?IqI4)dFDAMkQevi>@?XRf%!t(^zVoLMUW@q6VEvZS9+3VNV9|Pz zPdPjeoe;fD$88M@_B_{XXW-kj)3BFq4h7G8^TH8qRL;;6!Wox~XQ}oapcw>c@WmJ& z^Yw!$o)`k27};Z22rVc^$prd2Q!WZ)E{cF890ihcDvggFRr7W(`IOj$t$6vKw<=Y> zV2xjXO=eswml7VFK!<}4>Q);E_F&d_G!!I&ld|jA;~VD>zBV1SD`HH|sX}!ZXyhiR zW7$d>wL2$qSI^t&ZFIc*V2^=G_6g;vWzIhw;H-aZN>5g%fGB^1>q_sm6)#i{c=n<9bPSO!Y$cx0>>}lHmP^X_W>vs+lEdSP`?ZUw~b{@ zG6FgLfJcH=kB*M|swrKYl}=+IRb6sLbU=^oyo3n=PC_^2<3r*E98XM|gFB~-h8C!LaA7nQ(q;e!y;oz0 zziy*RrUCMV?h{w@FWK2rE-w7g?UC4H0*|BR@Pvew9S#C)418>#HitO5GjXj4*Qe+U zMdDA|mA;mrOx^vebq=#~2!m3;Xy}ZK>>)ul79-7W^smsLV$TNxN*un(({PWs9>3@0 zzd-R)bT+UTGfwW}*HfntxoWKS69W2MMoD;{WR4ue{32%cY;;2*Q4crPpqyz?0yor* zEA7wVk8ooRo&LUNs!f~uxAn8_a&$&xKb0+8_Oo5Wa>+X0r792F+}zwP`=CjR|NU@p z0|~J%=C05vWT+aUo!tP6efc)ABryoxiIKKJ52-=Fgt7!9t9ItyDvbN|SR{m~@#o3m z3?b30-hD4cF#8fNS8}T#yPgc8r8Cj;_`3e23sCz<3VR`?8K`(alC=&ImkLK+@SqlS zs;M?mx#9ycOe+IiHtYi`tIF|#?ClX>C=N^lN%($zbg%|#gEYHr9oM4r$iX=QT97c1 zatnwyM2ka(M4+_Z1qf*YJlb2yJg~_o}J6 za|p!YJIG#aD@qy~!58S|8a=52z9SWwVUP!QyAqClCnxm;H-2zJuTXAT8}R-1{{8?& zNCuq>>HGnyckY6RTxu|2G7wp2Mm3V1DCY6i(M(l;*2Q+bpEkJa{q<8BN{XU%?ZA;p z_s(as$|3_l)%&Ai>*%q!8L8zx9WX=91iivS4BXc9^3t*bqKN0YLurzp{{vcu7P-6t z;Cl=uMkHtISGo6QX)WX}AzfGyhrETiSqg`}H7ts+H`864d_zgEF>~U`uIusaU67PG z{`KDi87Qy70hb?_r(xY1kRNBK+fP>K5Y5Zj71Gu|>wGZ7O{AuYb4->+x#ZHN9Z zjQcRW2%1A_HO&a=w_|_5K3OKYbVZJs-(1uF^Lc9-*%&TDZYDmfa*`tT-9gubc5_>r zo^vrRzaV1^7Cm7z8Oqdd+p6l64jRPxST6DxqVyeXzwJnyg>xIY}kD*XAzI7>ldOzKK@`MMg&5Z+lX0@AIhce2rWeEi3>ngmXuM zyU)?t&z^$F|4OG3;z=aLx99Bmf5Zz3WK;|VO(`yn#wxsD=P^y-{MB&x+6`{jH_s+w z8O0W|+GFuiygg3|ib54*X={BhZ|}!ZG!+WL+GCR{g_0^oh(#o9z$1(k|7Xgs@sVJp zwa^VgVs;4Q$*uA!gUcx0`bK521$m*hGkI=d1@35>GlVERpU46yH2G#T(He+ z*1XO&f96j^(PjDXL~k@VaA?*46%9jP+g=$XN>M6K{Z=~@5iMLZc~wT?fQp!6v?TIr z`$TtcE!;#EEnl*UK8*~w-A!8!tUHemXNbHqXM@An0 zsY1&}hFE4ii=N7WDunj_;^2;rY+?dizemSt0z!t62dy@sbMmi?f{ewVZcL}p^?V4I zWQ;*JflKgPY~e2~pOp*2A2tBizDc0k<-@vnX8_FK!!iNFBGywnUz`>BzeoWw+bJ{g zrlEn(L+^8Q&<#UMKZv@Q>59^QkhCpyhi`aGS(nEzqZD1W-I@7T@;3^!JSoH7@|V=r z5WvK~ta%Emzw|ouPA+KoSmN;9GPsK#g0~T3^(O$oNChOu+6Njop&^4bv~Ae>j*ZMu z@~iIE^eH67go4!RymZ$MM%K2=qa94UpT8*mGPLSoNQpusi@nBwqRxlVT<~7`%-E~5 zsV`hTX@zliqNUE|{x9BhJ~^OBj6@Q2bWsv{FCb?F-(Gp7BpIRu)wct8^BIa|Kx$gO;i<4;mRAO zARK~(ipT^DoX3tXaoBv%uu-DsBu{2T&4xqiUXC@i39TgS6^`vl^ z+i|Dq#8U3;$+2&VuPu@m5U%-O%;tr^+!6*&z`ayn*8F8z>L+hp?MJ$H=6=d!`g7cv z6(>~>F*ZKyo`8P;76rdKZ%=P7gyM5sm{X+2f_ z6qZG9E{Eb3r7@}_1JS=2a6mQm(CFR!dg^E{fdcH&vkR}`wj}QtQu6p;)Bcrwx#PpQ zup}9sL!2^|Lq+aaG9ruq;6V?)j+!+-HC|z7@N(=a|HE}T zzJ1shqO|}q;c4FEjtFmDDjVTWTFdY_MG`wXUoSjKz8e@J((01-4fLx$1^#5o5Q6l! zN^q&ga8ben{Q)oE=C6@|Rz>$cmS6 zNRPIrtPG^OhvJB3#?rsdC|V9;zKdE;bAR5i*fZI8weHF5Sapr`Pc&cdaVGB`zfTM6 z3c8i-Mp&SXbdX2fY^6@0&0~Jzo zjIb?&H&z&56s~aF4YtqXAEJeuDsD%)iQKn2Z%2_fR#vQ0tPvEfNSCLmd+Q!26NBns zvkw7@n1PDlU)M~Kk;LY)3MKSeVh;Ky9ann0I ztja<;cIUrQ6q>zd@sDG2l;JMH%vj{Yz|~Ar&S7SvJ$|U}ib;I`pPAx=YGA-+s0GTv z_(FvFa%zp*lbmjpZ}~}S7q6gxg*N#$eme1-Uhm2|u6N#@%#sxLCOP+B zDQG1|{}#>Ibs2@v-R-oohynjI!2D&vAfbx~D4L_Z=INM)3ojKb1r6>5&~&>z80|8~ z1ect+q@2H$D4B+_6}RsG?kCmrz2wK*EUxheF`pi!)yo+|E$G4MZTg>HZjnA;UctQu z{rkN^I1u;iwGc>;E$u)8By#v*0zNpeLqh#pSn65#z30BEI6^FKr2I;v4DvdDs#{sIIiLc&p|KK6tD14aofY?yA6v-b zZ#T5X91i91J7P`g-W618Y#`8x_&uEzF-`tMriV_N$&2HISmF@Sj{P%u|5Q4)oZ7!g zd?x_O1RAt`y5<+`Y=ZCw|-iDCd+cgf>NChAW&wr4mfOOJB)J zto`k!Lid47Do{!0e5AVTJ_%pkzCbb;1zPcq=C>3kzDnR0O#gI?KjlPFQqSoBm@TL! z(3<@2u!xhL8uwB&NCv7ehJ=um z3%<`z7O?Ag{>Y>hWTb%h+BW$&qpC^cIg6$Lt>T=6{JWJ-L)0%1taisUMEAa=V5Yv5F+q zbQ^l8QyO#T?{SXyJLAT@;;LorJn;Jyiv?7RBZ8vud50p2G*M?oFL)11#s7i}<+Ci` z+xbgj&~DgWZSWvyjw8Z1j@s%)EK^hXq(RE1_Woz$AH6jhi{0D07~fLGE1BpUvQQ1@ z^xgk{ll}4Z3ih@{n*r6sI{yW3s<<}qXA`tJE*K%iyOiHDt542ORY3`9G-{DOzP|nBv8K?K! zCJlb_6(pqP|M&Zb!Ugf|Q~7g&GudlaT9z%>*A1U>v5ZIs+}tD8I*>z>DoGi{cHiNO zK8qI&w~Y6(R;W|MH5I4UJJJ2t59l-!8G69n`g-Djvni!#)#BEZV^*Ko-nP5h602A; z_OR}609JehNpAQHZgt*PNNWFA6iw6?9?fyfDxSpOKThd0$pp~=qv0#Fbt=?!^5v^I zUL#kNiicQ@#H=AMUX^!Vph6kMI2~wPDFlth$9|Gb*JiS8lZ|{;yL_&rx6407xqR$k zHaa3xYu-bg7}xnvq8YI31p&S2F3BZ_X1TO>h$j)~5d12wh?ClD8A(}P;_h1HZ}in% zly2l3caY)s!{MJTG>X~OwqWp)3ucZyN17pI**f=tBAxy^8sw z?7|;fy2PRApQtP1?OU-g_N5}PcZtK%WVwV2)kb*azFw+}-)1@GAlK z8reFPGz5rm{|ftXyrIc*a^^VIs`%4qlE<$<5ol#$tF{-v^==LH;Bp*#;uvrav(O1+ zH@oy9NmEip;jX?duR>2Z0g3@nf1PTa?7h0{q7^TOz!62Mn|Ldq4E-v?5?G8P_sdT} z4Y_89r&0EzOiB@ABFjI$>NJT!r!tH)zNnpeUASa5BP~n)OktCJeN)I}jBa0H;rwfx zPW<+T;YeX*2jZoB#u)8CC0>?$b9E$DT-#+;`pr?(y$*3YR0tZ&$nz0J*|_I%ikcC) zH_EIY)L+Z46tUTRhUECOO!v^%F8)7uLUofmrkE}SNn$16vB9{HCNf>IJk~$eQ1&$s z?d%7O2+F53iwG_1+y#X6J}pZ#jpoU0nL8W(&)bc$^5b7rX=K(!9pti_qFzI)|E}LC z@DlgNKWkD-r`4-YL)*qZLC(8sBqI=%p$IxhM0B0)s{|V_NeR`IvPep|M`Syv@Q>HF zat;&;RTsZA)^R33@Q78MM`DR?!h%|{>4PSBKmJ;w>9{|m<0JvX`V9M;c-U{u>`Z@V zx^NyYjDu;J&%`bT$$iQ}#yMDVeY%_-PRXX<`Sn>h&79`5ofQ|E=dPgkV`*P;*`c9+ zm0*%zXYmxLq*`ANl_2`tA)J8i&|0*EhJ4E~NHAH{Vnk^!3?1e3%1Gu7gQSzv)Oju3 zgZ!1PY=P@mPrf8}VVBk}HBYfvU#P+7n_Z1f)m?IZ87CI2h|8G_VCIQq&^^vMcGFMS zWP0)sp zY(kFFbICQ{KIIfP^AnKUmWJ_Xy4wgq8)hTq0KR1OGjSVf-b>}~Vk6!MhHF23(eW(z z@D5`G>j8T{V7%4hS$W`ntLM&W?Z3qTI2#ZuCb3hx0%6<$La{do*&C(iI7Uf1#+n$> z(+?(jd3W`Fm1B;!iGR!e+f`xb2mD_PC^c7#cI!KSXjtAH>f83FSaz4LO(NeWr6#!8?#DL9r0N;r-(wXQ8DFqkf2qIz zOJb$y&VgSJ(98qAbH|JN(5zllXJ|dRyAlaevC? z&pdpGz^$?;wXru-qrCe&6seGr-Xdt&KUzNd{Uy7`!qL;&)WV`3gbw#@9q7VE8kzT2 zuzf6t@Q8Jki!>EyUd*rCv0o?GJQxJZxB4M#1h*bluHuu?-LLknxad*Wjlj#xuQwXi zcTg~SQK^*P@zGxX+@XN$dgn{t!EQ>fMYl?SuX@{5{!Buc=p3$7Xz>(I;lEaA z3!Ly#G62@-?I*`%Bis2+61VV=nEueeXn*@nc=*)T4l)+Pz`{~j^8)W^IpO`hP{9FA zqQQu2P$+{TJNfH`1nME5>(~*L#M9Df(-E|XwOXQBWOQ5{`|FR5*DS`SmSHqTZWQBA zu%bJqX#HbQVpnHSeIqL6#n{Ydt%EkQ7wPcWWG1SCgLylJ@y_0xrb31 zmEK9<&E>Jrfyq&+@k_sbz;TLi0w&}@)Q<08a>&pqBy=3MmJ*c`^^AAle$1>>aV0G+ zO?yaWZ~6jsaMRM!AtR?X*&bU=28M=MZdYP{V#oYEN>2VL-mGKId&P?P6AuxLu){-v z=_$(nPFK#WHqV9@9Va?yo9)fZg%*1Fq9`al_ zZRV7I^(DGM8-_;l}<6_zI(ZxUF~ zs&HotX`9ZN4r+|tC?|VL*SSftC+vTjlDDVx<(o_OzS-r2y%yOG^WXTDA1i&zzi8r` z6q}-!JwGC}Rb+T1SF{tBYFda0ABS7fmv}9cc0%>nDsFg$OvKVd3GzLskxS3tRlN)P z_?$+qzA)J|;Q7y*-tLb2%ezyyi{kdOi3JB5;hhgMi%65TJ&)|a<>ya8-?Zwt6PVC^ z`1o-k41DyO9w3eQFiH3Xir~OKahA(>v^8O5rvKYBr7Gf=m3u!eSD~$c-)t;b-=EnD zx?Vqg`$hso8^&g45j%{mtk6}m&9rOs&l|GTEwP#X>E?S9l<3pNU) z4wofr6Ir3SF!uKTPCtlgb#>9_*8~ajx#Q+u+ca&yvdFfF))_pg+ais(*=J<>x_fBy z301kjeN1b4^)6l*2Q?^9^}Rs-Y7)2MQ$ukS&8_jN?1CD-Zl}y=ePZ+O)h+^1GGEvc zoQe9x)^iZr_hhKRB7wWS(4GiIGd3q-Xm}ka2ZDYWJX?x!Sn{dpiCWDsblxG(Zdm#A zq-QN<1D)daif_E(IGh~eL3Ay06k3(|$q=5cDlQk5h;Q9SH19-w3Y>8gH0wbBnoQJb z-SIoOY`owl0PABgr&5!_NZh7GoAqbu7WM!cbE>GQ@O^yY+^DnSO_{Sllx_sm!N4tk zxppXcD8t|hv~*vE;nnG_$=xZ?Fp*$!hT6>w#yJ~SgpXqtp?l2O!s4z=35lK{NkmiP z=Yqi{2W4gDsyBQTW9}XT>s>GV?b?!ZdN)Vo)epxLNTbxv>OC!^Q}$1{xsLm&lHed` zdEr9QUIs_e(Xh4lfxs0)IAQ|mx_jN1Y9Q-RQDRknL8r!`d%}{*XfoQUq8@0Vo7F*K zl6uzx{H6u^}~tt{+{XB zcpVGN! z?C|SDHe=@?UcQh*s}ghHw>@J#72!hC(^BZKm)24k-#4NKLpfqMzLRgHl_s7>hQNXw zkR*eGkgt(wNx{(jrBgeu!KhBiZ7nZ7>kEEu_pWm&8CzxiKn=)Ztr~P`u)&Q_D!$$ zw;}&#=b)MBXxE4tKkl8)J)u@7&G0b&&BBohtKCci-MPOz4RkinKa;I4=!%{+l2vxC z4t>+h#cn!je>>Kct=)D@YELasY#JKzq@WF;0&oD+;0biN+&1I6tdga9$z}{@+PH4t z{`kQQU3Tg%CH?i7iOsOpJFRHA{Pc&lwT;fa&dh+oURy-4mQYh0qfie5Xs2T@FfW!h z>F;aPIJG;Arx3_>4B;>t>PWMA8SX9XFs*lLP0TGF*LGZZ=_mIrZp!BRlQ-V27ZNnX zzwT6Y9{s`51NzT7CPgp=IYG~;HMAPb@%-EDp*l3Kqzp+S0h4Z+qG1Y zv{K}7&FQCHBazwtM=}o4Bo0)X5uIm>E78V6w8`++x~NFQn&5FT)ZNGnPYT>+?Zt;CGbu1MkxYlTx%*F4N;EPC~J z>jHT#G?Z_Y4?YytDvDEdNEq5JFjE>|h*Y7YY1kq^ijzMuy&kFjOpYS#+j5JDqiT;M z{zU~D^;xy$h~JMI7)fQ9h$o=G%Sm_sT4kYi;%_Lpf9PR|*%pZSXC0AlSvwgPI>zMG z0uvc~-;IV~JRf~I0g{X3nEUN_{!;ifAslYGCnP9cMX{3Mpo@gdr;6YCeAY8D&r|{=~1XIDc=NoEEIO6 zQuA*sY!arx2`nN$qVAGeJN{hg%BiEfFEsJ^f!Ai8$^{=H%H;@?#Xgt5x$|k8`~(mD z#w+QkQw|)3m%hC9!+FrS(^}DdPug3XzTB}$H$3&*)@Jo`gv5ekBtu=)wFd+|9ow3 z%Ad@j=$x0J+T(@8*EOGKfW(q@@O z1`s>mu9AjMRr?eNLsNtlDO2M>y18R?hdlqiC_sTc^fx3cHeHk6wiyc3cSkB^+ z*|ffqWDI@47*iYgQFa7XM!&LEDWBvYxAA&IGjca_*<@asb1{}&a6h=*T&QBe{0}AM z`}k?8Vli#WH(Xk$B$$)dHh(Uk!s#_lFggMX%q^$)#aGjtJA1Qu^xh=Q@txKQkAq%{CAJrwoqJ`X>k0^Y;(GowrpE z)!)Pspbt=w+(>C(9Ams5L<>_*G(pW0KaS;sjdvD8<-UmB#kHKU^?d$Ll2K`HyBr-( zgld=Cc%90>aAk`~N}lUCh*=pvY;wLDt`eJ@)HLi@;{N^S1>}(MODe@ABOUbZWvpT? zRlQo{yz8HpT@fxD+2*fl5zDhge5&bPeT;8EesXWS&c4+jH)q8MnP+s01V8Tq$gb}- zlOq1w?_;^N-X~FvlK*f|q_m>>u&XzCpYSpl`a|vMv8F^4RvD-i8!s1tT6Y!4BJqYg z$b%Bl<|In+8U5OGqt>|}0SP|x;~O?I#hB@4O2!J!QJ-E6^t`K&lYf3=#d`g4`r&n2 z0%0U@+&&yE@}nEBZlqr(koxoM!)W6XQ6A4B)))g7a<7k8GCTNp?k=V<6IL9Nt5dvk zR+HB?b2C=QKg#>)DC#FcCr1!FlPEabY(EOpzu@+J!-(bNA6IBM)G_XovE~etZ&-Ln zVi%e9y@Q8UOA$7PGEGaaT<(^4YqSo?tSe>SGF z3MS=!Iwuj*KXE>pOqP;zD*_!Pu-Isxv_~lnqVXg&vJFwZ)_VP+<u zug2l`xE$}ZvcE(bB+C?QeN{?VjhlCU12K{>{#A8hMH=P1CD;Gui%|EXgt*d7(bS}n zS|~}0GwT4#6Zf#SKr%WWa}q;RNeO>aNtX%c54N8*bzMR1m0V0Wyh)&*GHU2}q`FU= z*=O=PK4Y=aS1|Ofn@zm3SCi|y`}DiY(N!WBoGS6Gye|Cq;z7PHtpN=a*|Fen+X1Wd zxdOxJ<{lKN5BaXU`6~+lyKJ7w?`q2bf7p7|m_38fT}4hdl-XHY^) zKq=|&?uH=*1`rqt0YzyLkVd6bx;v#MeAno`pXc7s|NXWxG zyOfkMH=})>-wJduBOLn`jBDUGO@10`5NA>+Uj{aPM51&R?ZPPg$ z%h4sM$C}N+v`TE~WTEt!oDM)VphfL~(}%d>tM>o=K%iNoaSKoYrEQq9;a4%=kT79K zD3O<1Z6@rCe33g_fzew^ngT~k^t=OrBvpp=b~_lPdWZ#4t;$;w+)$6OOst*b&pPH% zQ3YY9Ql$Kny(agAX@5fP^Ox3f;LQKk`)?~z10OI}BlFCwLyx~h^zwWq@_O09i)b|t zpX^mAdXpU2)?NUPAM$Z?4k+eT|4Aa}4~-NoN%X;B${jRgUL%5Xl+1+frOdQBG*6MwfaZ^PC)*E?YN(+s#Uk7p92hAcx&QHeNg zo0UH`qUVJJ_|of~A_>8qYcU2{fF65gUSP_RGUsgm4@4h=dnu??2$c(?DwyzO#%r!1 zqf@%SB!8I(;0#FOolpUp_d{JtqZdG$uA!$V7XFAjovjpyj!W5MdtDBmD#=oSU}wh% z@S?Bs~kD+z9Ks3jD+rLUA8#g*3fiC-jHR zf!paYlkW{_PAPsW=zL>9V+6YG69mbA`FfL_9qjS|`p!j7#wLEJ6e6+Fh&W7tL@dK{ zV`2YO3N6E5JpjOwrpbz7^Nz}@UH6&Um4kqAO8yp}dAtIb)$GmQy>73Nm!|y$nJ*VA|#mh~4UZRn7Ltbu{AqBM2Ua(ab=IV4VB8&U&iK$RR-UuO6Hn~o(*75%%LTYK{;P^XJw3;QI*gQ;Fr z7HbdqnOL7Vc7wfuJJZ^b6BpoLkfP)`JjDjzQSu0qzrq+a8S{o)Lfz^Y-sA5KaNF6u zoP+18su_o$h8E#qH?_wo2Hlt2QeO=N;M{uJa#GpNV*@vj1v>BR#{i| zK)N{+n6dSPPeZ+#J-4W-+6{?<;pY5vMw0-VLXDWqO5}&*2&D%b{I|ua{tog7)MuTr zsV2L)gi7X{wrGMaW}}`=x8K-VDYV>F2zz{2Gm(p`^xc>H+T00qrO{woCwPh3K9uBf zZs;6K_m}5A`^=Mx=k&{w(F<^yJ<~I?t8_)JaK!bK^nzgw+8B7elJ~;VrxYdceQQm6!8NL=Q`H#BIMZ&rL7~{!v3TG=?|F+VZsTGT+~N=gg`*!2;Hp% z0&KZ=G2VB@?PfoL?WaU^S-^*nw!FArCuxx!6)Wh91^Eagk}be<%ykjkw`Y%`7>Vu*;OmpvO@C9n zFSF_R^+m_){~3#aL+Ka`FM#snLw*C(%RUMK8j3^g^t9)lZZ@$1QYZ1EjyzcU-*-20 z2Yq)x68Vd(M+$@EMynGb_=f6Z}%xZA1Uf*31%V63FRTwJhJNHa>u27O(t-AzB= zwQrZrEegu&1)1&1TqA>}jhyXa6oegG9ZF>$fT8AZ?UPCL{zL}&MKbt6w35odzbn{u zo>**roOgF3ff!pwu)mGt!9|LLhf#mtXzP2oveJD*RXGbkGN^JErGH^aTw4!fVcV-w zjmzVgAwsQ4svw-?cmxYVt=@Z5{~w?zl%BKi4c`e?l!Qm$q7P!795vxNY%?3>D)Pm6 z&OTCPsvjGYrell=$&}_IF`B9jw@N|pLg9s=F4PD?0t^(g=r}~Vyc8TH`{*^S^;Q-K zRS%nBWjFMQ`VAryCga?K+lMGt7txFqM_p9xvUlEwZ*1oAtbGuRPcH8Ko)Ewh$qS~T zfS!D4sm2YNxaC_PG@e_g@Vx^8{nuUA``du3pqWzZJNzW!j#q<$f zBnya0VfcoD_U4R7($9yDy`bccI9nGP9FGw+CHJY-R?4q^{AZnyGl%}T#o~FMsWkBJ zKt0zYj3W3k+gO7-i7+Olmo|eZs;D!g-qcZ|ZI9_+Zxf)xG(v6xOy`iy_CbJR9?-AY z4%-=mBC~Rv7wm==aPFrr4@ljwYtDITpz9*%g$9%7A#ff*Pf6eQ{73NYFypVf(}@}8H4V62|1y1Z>f>;0;E~W zDFS95+t*R}N*PgXyRDF&$iJ4uCue#fS^S4MuDrQ{a&oL>U9-!d@(o zBFVkKwuc#3GsUlv)lksPMfI-kCf>)PL*L(iIrFx;^4-ZFk40Z}>h`M?&2%AQ^~IAK zv(M$yWy6L#Uvkx{zuD9&e&)&IJ2U^VqV}<4e{C2iJ09je7`rU2N5AOLJ**jPsA3Rz zt(W@LN1q*}pM=rDMg$P>qS2W&dWwY8wgYpXgz^8`zM*76yGcqiPo{~k=@!{C7nipRTgY}cguLgKmFJqNGgld8 znqHgC1*2s#n*;)i-JJx?-oEsB)_Ng1%{9lLPpSuK&NbvS>W9adH^E99Et1x}Dw>%i zjU|vQFl9YM6PCerj|=N#b0(oIDL?mP$Hz}J2^inRyI+;Cli&QSsQd#V_5W~yeN9S# zYC;!JPql-Ka(@A!A1SGR&fk~XcDt=~ao&_e1A76SO8lC|jYGE_ zdGQ*@G7mYCK*--v&CvkdQ8*nVU_z}bh)B*tiO4DTjx<0!H1j|!j|(}V7(4UVE~UvA zpL4U?O+N#S?TqlfJJ=BWhKT<-NaqFttUJFRYh}*hNYD9c;h5^)Roh*7;5dls&#oY5RLcDl>QHqn zN$TdesKMv=Hku)suVOy0QS=J!YRJ)Sh?VfK2^zlVv761q_YQ_FY=f#&>c1aL=(D(6 zk8Yy;+SKlpyHDT7!@NuVc$^p8Z;y}RDJU*o_nsC?B#|jk^rzP7j2hex7Z&HB2FDe7 zd@;K<`|91Z*0lV9-jN4X-PfeRVym{vz%*j$5IT(GQq1E^&yi3u#^v$dqU~u`{nGBJ zM(yLPhrOa7;n3w{NyxabJ~`@T%y+~AHOYuu`-MkK?TXKa6?2yO?Qf6!lO|8PxD+_q zW~8hm=CS^_yb~zg68V7xp-nwkJ$k%X z0h$NpH!{}$9*{-YSCzR)MB@q^O8i)CLzKU$;Zp zWZ8yYvdkmT21n_1o`Tkr*%mdi7UyUoP{xHbTHq}7>&gd)R`p>H1PhKJJK{muu zIAY(v!(VO3!OC3@23|s7Ue6NP=~kB5!U;tNX{S_&$Ej+3_*&Vam4#b~1rOLKMde&A z@PB~449KcD^h|EvE;~%;SXGYc+xI#zyt{+Q{ouqRxPPkqn2_Y369IApSB8+0Ti*i) zkL>BkPKyKvJD0X3G@#jGWCdRIWwjzuvfll7S<@w?%$peCtmKin>qs@Cz#m}uADHx; z2mEiG@csV!7Qk5-g0eZbU9IE(@ZDfZi) zF8c0$-l~~8U)*1rJKFu3nZdJ$zIt6_F;TFC4l|$~Q|Y?@{98FSeaUXy(nF`_bBBV= zCeuFq7f{`E`NIjM(kRK*<}M%zYxLVbDMHl*ViaY-gywkIdCp#rrsL2$J1RwEtO2YX z=rS}0a+kB`xW2FJE~tp+$>Opr+xGnb97M#I0pUq2cq(0owX6(mPr;O!=k^=>izsA_ ze9`leY38qG;SWQGPE2&&$`#*{fxZ_3jryIIi@_3EihM9@XWziKUjNxC6AFH5pZHN8 zb(QP)P$tOwC1)`Qvt3@c`g?m;PY9!lM+|Wxx|Y8RKYa(!2~#`!g$l0wR^rvQ65KW#xxG0d;d~MWIZxtCl#ooXbv<6ZMM%>>)evH)T?LFp^}$@Xu^%1nlO; zDO>f?kN@%;#f$YLzWwDl9sZraf5>*T3;D?7eCJa3J(;ICMK8(BS?E(&=s&It1(X67 zTOwSdsF#HHfUaBz>XXm&@;+fy(HHYAdn11nBhkWXCjUZ~VjKZj z9U0G$hYsU(Y;f+(DHNz5BV)nbfKo3SUB+&V8j2Q}f0*BPc{ldt+El^hMsrrWs|v5+ zqpi8k565plYm;C3R=H!A`T5?F5+A-+&=n|!)0cGbwk1Dm924@<->I{rCviY41NcYTNnhNr7&X(T+@-75{GeNQD?<#Z~m$eNnxG z(X6C>J`=H$6~7wyr`g3q3Pyf7A;i|%7uLIn7{sEuki2gmfG2AuV4yazP(Hr-{V`{l zIdlZHnT7hF|43*?f{O+xwd*NdLSXY#;ALLY%BYJ?0v+PhO`-e!ze|&{ZQFppL+2Jt ziu7kXC%;RKrzJn4vl}WXz`NW5%B%cw47b7LI0QJJ(3yUEuBP_T%Z?Frz==GiMb)j$ zZXcF)$9q4V4q(dF%KOHS8nZH1JKjC*wigZ1tH&Zp#9D_eF|Rhb#I+(}VRB|Kxn$S( z#T7#Nh=mpwv4|l4*rr%f??O_{z|eIZY4VUz{?COzyafhJI3Wfclg+dMNXGtQ`DN0= zB;YPoR0+%lhP!gLmTDgaUjs)elGeXhs?m24{1Eglz{;+*150>kI6^Fr>#rQLZcNy3 zc}>D|nG(#=7#bVA$PAlaU?`dw0LD%pp6ZtIOr(X71{HZ9o-<_ip`R+ZM?S+|b3Eug>PGy-hK0^s~%EArf(t;YOOxs-7$R0!k9mRq#dRXxca@t|c@4o~%bf zekb?YCKz;7H`K7sd5lI77W|B zeF9sh$rHDT7SM3j|26g=qGY6_Emg0e8TGV8Aw#D>=YtQQfh!anuyvrMo3r*cUeEvV z(FK^?)%)-fXTrRh6#N3r9zTiN5<3WkJzoj_#wEl8*E?w0uO+=^Y-IDO`QjrO_*v|v za*@x;wGys5)&m`Q!kU2LU_y|e@=8A7C;?fC2> zbsT$t1c^SQ0&i z$6j^QB@u8H5Q4$sfL$=rDcw*Ny9uvixK$14TcFWgGv!roEg0$Uh|RW0X>r#o#C zFQ(ZsCA{92v0iLt8s`#m=nvf1+gQ#ynA`SR@0Ngbe}G?)cTCOF6UDkrMH_ekI=1C{ z!%C(0oLCjyVGc3zWE!Vg8xfhz59URQgxy@puZvT&?`RM(+D&JO-jnN1T8QpTazqj1 zklNg!5=H61hGAsF!23Jpt3tm2YgO5y!=qwP0b0@9W*oR!_-b8(!I}lAQR#n`u>X$- zPWT;7ZjgR+c6RnN`!}#f`42XUH3Qy&_vgUDq`O+6W3N;CiVT=oF`{E_Ku`xZU&9_I zh%4Cx)Er3*fY=MIb`-%XLnub{_2&@ovM5@W`H(-e&@!o!G;9-44<-r7R)vfuHoJPq zm&H=Az@4BqeSQrY<_dM_%|P&p=P@)`kONN!bdQE}p>p4|)Vf+R^D!j>P_}wmi9sOn z^9Wcu`AfAb#{#X$hV3oF7e-Voz`1!Q)JGOz+#IA*lpo!QUVJz z!i!&HO&!2>1_J_^zQT9!T7m86on0`nL;HKanyA1BmU<`uaXzV6eUm5m>rq|nynidR z&+`Eb!F~%tQU$WyHP^+xZ6H93E{~tA)B|xr@r+|m;t)m`p?8nu?nhMU)`Zg-^h?RO5P z;~YrXNEP4pTG`A~O&U%T+XO*7z|3#c(GywBoqRx=yZe10c zTP=Fu$Bc`l(IxzOCgP+|&EUm&`qQ4m^OcX109$uwFKz2>21mp6g{aA$lMBmhbBzSw?7#g&`ab1#m<@RWp}^pjR+sc)IUa%jZcKZc zxpS~f0En~!-9%%L4`md&oQlpd#<>(H20Eb`m-J1LQ_1YBE~tZ%_F1~3nUcvEz^BKz zefrlcq$x7tm&4s1qycb({knU4Ur=WNtZY!Ed$t zZ1F+U84-i`o^19uuPEHWd`;A zGc&P(?^|=OD;(8wf{{}_6VG3Ldw@8#-dLx2k@~oGAIm~~zHuDqSrUkW*o-wgTzsJ# zWCM4b)RzUtebOQecxx#JnGYd?}BDWSpay2 z>#VK^OJcKN{Ty^Il+wZXjav2i_y8I>bv5BCC@jpv$H$jzEstZ$zmDxZ@wrd`CyWZ8ZsXL zAiMAL>(?)SU@=*uQ;ykmvCOv*%x#~8_^(0`O(YvoU%CLoRzNx64&p*CrDCNEw3LvUn@AftAiZ!{O0gi8J=&F_-xw>z80uaFtWCj{GV%^=pv#`;FHDze}W$y+iyu zLtlQW>7TB?H&#||sq&%$eoChT#BbqN!1aqPlBP+TqY%CUW&yn(7fx#~Hzd5K?|Ps7 z;Nk36>gbe~bkZ0*To1sR+Kbyxi%$)$_VZTkIuJYyIO(5UZF}VAO_29-2s5i7#%p6g z&+mz`X9V`|tNE$463gXJ&&q3yvHkRgiNG;Q3w3Pk=YeZDsTuUFm$%(!HTtOjt=q}) zVyfNl$#r%<{+sAkrN$omy#Ju$Oo`&D1nWo($M5R?&GB8|O7h=DA|X!*6c?^g%Ri4@ zjIx`5PktaNNPRiqeslHAU?}jBl%h>N6`zk^>=aJtnBeXhV@_FX=-AV~R!fDKP1X}0 zABnUtF0Cnb6ZhADBk2w$E_bG}+|eE?{{^BC7c}P$HLW#1sBeLm&nvdeq2as zA%rEuE8?ou88pUu)*_rP3!FJ?Trj)Q(m%+(H8^*{nM?H$t zh*5d#T%m#Vh3BeBBoc&z$$NpYo4iw2UL>qDjoetVg34RwieTP+oL&La0yJu-mFxCDrbmYAAHzj^oW+q)hA zQyqArDT$j`p%5@Q3Ibwzm+jFU9zCZ{vvZ<5tDU|z%2oq6QZqui6sRH1-J^!ilXTz9 zG}gc9z>}=g^|C~DrK*fqxg>SNW~4Ygf2B3VH63WSVjbQ0w&od}xYMhGQLJZQT&i6; zG5Lh&GF{lo?Cscr*VXUp0_x}8mLcxv8G2KoQ6Px9xBnZ-PLhgO@l=-7zS!Vbxw-t) z$i6cXa}$OuxWn~qdW)9J$J3M54AxkX?~F-Q_Nt2qDqvv0pyWid64R4V9mN9hfTh5% z)%n--;Z@333D%qCVG@2E&)5ZQ&oaq$4m_xi$K1ZG1dlCApjPu*gdk?eg(^*b??$W= zQc4t*6|V#3=bQyRPMZf;Own(0%r4ni_p{X~UZ$v2=jx~9Nq7{fC-&w-KO6Eioc)oY za2Xq>E3&HMNsLYfZ3w?>Xnf;59px%ss{EteY0Uq}E44JC5VSc|9Pqgcky6xyZ;gSS zFCf;ZuvEGG_{#eFq5fsWyBw!pz>UUDP3e1s@IT^BUr^Qn{yyfeObmnM4NyRy0(0tR z9}pa~2lhyG6o-K1%NA+iOTu(7rz?^Ep2awjxB_4INE_cT{2TcX{CmhQP08f2cqu7$ zTL=zgUQ83YNEEDMLw~~WN!t09Qi>U*WD`3<$pLM|cj;v{5j4%SB3N_#{WA9JhLwo! z!dIA#ZulYhmj@WLDz%rci@&#hVvcF#rOp^D41GQVdP}k=;7I3f4#j{S>4g&(x`w2N z1+FT4gl0PR(xwt26`Kd%+Il43G*!uJc;FUo*Ch%Rr;H^B#Nu|_<*m&3@G#?%)Mmf3 z?yNOT?hu~6)?5~=0^^>%{#U_3g5>d$XU*qg-ac~tj{=*{7~pr{pU3iVHPlt&GS=R{ zS(YZwGACpQMyUV?B|}%YetJ@>4*tJ6MYr^IZ;`fA{Hqcd*Mw3kpndz%F^t~B)xh0~ z8f0+9U7Un5c;ca*zJa$mNKw3AqF+mnenEj_nhzuq<~C_lJ+IyLiwd3E0ix#~)BrDF zO&y)^$Go*>{Ha2(e$4-3cb~xfmLv84%h9{fmFk4$90{Dmb+>n^(ky=(3hu3YoLyd{ zar&sXf7pO^1k2KT{rD~?A3~m3>W2+KfGq3vO=Pp-T7o0I(?S97^Bw?#Zig-6MJd$_ zr8t*j)mxfYCq=@LL}LV%eDgdAfq?O*2y#+9uHk&L@CX5HmH537Y`xxFTMfJy-!ptcEay?=4`H`j1c@(crocL$(-|N1_ z+E8810NMN1djrkSjO*y$JoKI78lh|9YA=wWmS0Ew%-3;+7A*?@==PK0EazZt-J?Q5=Cr?ex`1tyYJ>R>`qei`zTe0^Afdm+XD7d}E?i=W`iL;p833*TCq-9_pZNh`=l~ z-*za_QhmlpYZ_!22d1;&#K=mDBIa^|R^r&sV)-k)s69QJJTE`9xbL||Tz(A?oz3LE=Km4tWU zpL*D#4sJU9OJlWC-kKYipN}lIDwsRXnmu>}L`TOYb`WASQ+d#BayhJjzuyIv2_l&m z>#~4d@hnwzgX? z?HxCRdW;%^aY!IjCH(_jhfTt3(X~zqEsoG-PB+lV&Me%u$426kqM%NL8kq@%^>S^g zVHx|C4>h?J-X~3K<4WpHoqBu~3XxKO%>^sdvUZzuG8$nkbyBHXBIN$2{wQ7c#+pNp znyxhxtclL~blHrEDdYQ;4Kw<{f~O+nyZB~bQ==3yL`V3YyzTSoBcb;qtk|GcH6vAU z_Zqpp-`b~?e{4zr%#xc6?SZ!wFO+1$^9!&QBqAa*WaVKE5l4YeKyKh&Iui@lNW#kP zgvvh;PJ(_C8PHkM!dILpv{yk#q=|SrjS#p?HPe20?>gs*wn1=LCEg?nLf}@SzWUWC zKSNx4~VfyyDI`WCuv_G95e;DRz`h zwYxU&+C5gezh=Cj*1Q%0qCB-y2q5ljSB!W}eo85n;s6mn9Tznyxtx) zbb*k&*>D!SxFaETz!%D1Qo5>L3zV|P|Bt)u9{~XlAz(y5%j;$V6^;n-hF4MGf_zAL z#yxMjQT3*;JBJLRuD93*-YP1o7@O*M?RRLW1O}xWYV~dBZ=yLCQV?*vl_B4NN<7r?T>#iGJic>0%b$FF4<4xZqn5vB z_Q@k3mR8X?-y5(Ry6n!@-sxOb(^NL-GIz~wv$vo_!>S3)G^IrR#6cB#}3P;VYghe6JF$vKv3HdTgx5&@s2b99M zET0Pc`zsOtKaU8QPtdXQ1YJ!jBI_%-w7K_zkl$lnaV=2g2MbHkD&cl9@it;&*Ac4v z{lv8zQBN=8g~Pw4ublDp!{s2A2x`hEx12FWbBUZ7XOfEwSUf=1DsDt~C+N$)p_c$t zIr*2y9E+fnd2zJJDmCfBpu<1kam#fF?E|rlNR%&1$x-7{wg*TR7>UBZ1}}VBz6!4@ zrQE|y)~0o}-F8}#rW%3xTd%}uIA>eLxAq39%pEvKUjCg9f6B$U_Ll|}KHQF>CH34^ z+j3H!OPA_OI)SWzOYB`XVJgsCfKO7NTUrEX0LwhcfGFxV6>$UH>L166Rx+lMuFQd} zR@AiYDzHOv;VpO^AbJdE0E5yH3ddfqWbmQp+#%@=G^O^flPAQ(ZeLqrElyD7)yC4! z-?i1^@|n&NA^PE1`Rg7xWW~&<6vnbGCZQN{U`;#S{Ek#=^0elg@cgA=A#5^#I+b$* zc!uYzS9nX5a264A^w&=qM>oguW;3nA;AUNqA8-<5QKPNQL|?+M14MBzz%PR2f%^4u zpJ{fMhNB&`$9(Dan7DKgTqpX6UxYE$C}5tLDybC(9U(u6;;cv({Ucu5|8x$FVK55v zxqzSo&Ol%?huARk^2RiB0SK7AUjDDlTnSwP{Q}AyiLDDZH|UEq8dNToZO2mn!*^u; zmM%GEa-NwuV}4FUa@lu&a8c#>?3!7V0E#%$aFg8;MdzHh}?yj!{BqI1jL&ki}}i{;P*T-bakPE6)0Swp1`bszt?k(vP0-stCbcDl&fXpmF` zTs)(HATUkIvzs5~YUQ>zeOF|Gw%6^DlYybOgu^Sh_zzAyi8qpyBh5aaZ0edRhXO2^ zIAPw{;52VL8Ew^xHv3bbTUyG9L2Cej-U-j$C`q6KUYt_B+uqDI(sUeYI)}Jkt*~M2 z!%^bHqN0fOj%|Ie&)^2-vYx$z&+oyfH{X#nWTHh4XweYc46JF_^@;cSK5^=^)&%{H z+9RA1JV2S?BQ^A}a!+CM>Ghh)lj3Jy1J);(Dg;aN8y`izGnK$K-%Q>H?bw1F9Moz8 zCTnupmH#p~#A=Df`NtWX}ytHhDGYOAYGPai~$p zUMe%2aZEKF^+aZ6luY<={hZVJ76Bc+ zg+AiHOsG&o&+uie2BO(&40^?^)_#()ibM;5-?7k#kGh4(j!sf%ETTiLdmuG;jHM@s z;H-wO=*xZ7l0*@`(R^$e(vE;XAg($YheZqgx@M@2goMOv9r>1FS=XFc93+tF>rBGj zVkax9&7Qpb|9hbVVFIDor9AkeC5qCbU{h%P4qsiBa@*_h%^N~?iqm7-Capy~wS!v}5Cjbk(##t8-<0`}0ea9G)|ZQx-=*H*e5r}QkJg-CQY zx>qekF+Ny=_u5fGWr4aY50&|;-*j#d7Sh)cp1~!Pm^1pV^Bu_fKaUTB1>fEeFz_QAgjRPn?Ak& z^~eVdL7Eeo55*vb*90-uoL&qR256#T$B=Z+i4(jRDh?sY-C|n;&hb6qLW5q^^ab~x zuR=6tEki2RgVk8CQOaI?3F>WGr_E1)sxm0QqAMnhmY1%XWK~$cN!%~1nChcggL@R%za;-|-p`vKg z{Gm~a$cm#?G$H>w4{0D%vzZEdSS(iJBL$zVq2QW*72PdJL)GbXtL-;e}x7Z zzLT}fhF{Uc>Ud)m0f-itVk@p!f8JnNV4LBUYs92!HCjm6Q2VaKZoC$5cG~&Y6ykrA zI=bUx@RdU6aCSMy?Y$mglNgO)t2jQjlcZ!Cx$DM4G%OUiT64?VRU8FSO62b!*kN7# zMNGGNBwdF+!YBT=Ka|V)9}yb-tB5dUXIZf?7>-W(3c$Pdo@aV`H@q}~Zz?{1_Pyhz zR5wh>FZocr%bi7kcn2ogX5C}6DIV{}*BU^DD{JE2$YpF?rO0ZW_>JcYomr$&#a{WL zw~CL*o_-Or^z&7TB?%o17m?F~+okk1xwURn%uTYi%k}0tC}T8_lcJ5vu*vV7 z=Z)Y2x;iAPfQqXZ3k!mL8YEE0^z(hJAeIKmD~^B0@$5VVdEog~Wu!H6VV1cQ2@_YV zI9qb{X=uXe%H^&b!z%~aw6p(+NX@ji;_Zb91LqTOywB1H93x{skbOXI)R4&Y3dX0q*M^8QYn zyQi`{TKJ9jVFVk%5?U0@PM@GcM<5Rt|Af~!*tRYp*$p%;mx4d2TpJ5sg6jKWr5<+c zQaTVZY;KAb#W=XWZkljXpCeF5T&I59Lzj_(qwZs_9W7tv;GvJ$IQBY^AWb?k!FQXj zthwFHMI?snuaY`9JYnZa|Gq#|Hq-6J8PMvi0Z+g#IHzcz-xF+zj+FT|*kQuWVS?|9 z;K8;JSE2R=2#2jlIp${{7R47RCTU6M%|#i5gVXcU;-Z_;%AKd@ZXkGcr}hJ(LW&t^ zoc7XZW63z?a8c2p#gU>R3U$MY2r6sg#pp*;*Uul}J(T>{vjc3B-fk6HKFUsF7FT7w zC!H_-SH9w!ONou-U`tT@&kdPZE3zw|WIp!tIoXdt2n3^gCJ|IkIB5W9GA~dxE+VX= zO5tCPw)d;LHu#Y+fAOU5;rB7g;{H<7!@-@i(wyRI!ncyAPFDnw zuUte?Ew2iqgRhbpTb-b_@$Nuw|EDk_gS&Puw%<2NtR*K3W#feo zv@<1yJAb7mlUzI)G*%hR8Cq!`xNWCRnB6dDM7gG3`xx@$+0Z=et9DFHGm#y~mFU<) zA9Zqc!m`AiPo5q6J+67^U_wS6g7GH*}(3iqC4~RW(7kQ-&)} zT6Rd$CIS}tMiNlxaH_CF{_khJ|L%2O{TwpdGK*V z{FSD-TF1(nThnlr?mQ*kp_r;psdK_TslLe`=UmjYa^nOtP!|`rxc2Mj<)<8Ncj_&5 zdf0SwL7IsO6uHDgW$ddp?ED#Zw}@T*yyrVtcTtVMV0Um+~0wO*ig3LjX>RX$3i%r0}FrH&KB=wK90a%I( zkce>wDjN8t%)arIG+=z0#IF*>+&_#otaBZa?{8V9d@X_9H&nSoNmoUGfF#6i z>u@0F+{z?~W2fuJz}hqI&hiy<8LGS9{zHzgY{CW~l-BG})jQw}*$S6bQAp5eu}d~X$XD{ov05tBL8`>MmgCdVpq>Xo5xi-oA(aR3&;FI2ajP{sNf{RtI27=SUEndm4N&9vA^Y>RB6 z6-8Z)WHI4=e8xS6@9i(R-aEn3k~8G4T0aRJVTrQ33LkZ7Q3$=tMbJBz*@Ip$+GL=I z@9F6)?Q}`R{MQ+)gD!;Cc2(Xql_#TBx@oa&*hlYm7x#^%R`-9i;P7OQr9+!dhBDHE$Va|%%UldzL3cg z%+zV8WHSr|GlN;Z&-w9}_2`)Jwm$+_cFHerqt9;oF+}Q&8RP=$%*$GQDdo*&Wuo{C z6WKk0%#(;ShU0q=1ZQGpy@t(z&2x>``G%;7gdXOIVLrtvq}tj>-!Og5%Q)v2#}2;t zl|m62)?H{j3z~qgbg$UmAN~CB6InMe?lUH!R?YpoJbb>oLSeD96QpQgo%je^(q~Ze z-XnoN8?=8I^%0RraiqbX|3akXf5XJU@QW7&xB6F`152CQTG53dmeAYc06$4sQ5NU` zQ}dnWhA5moVD=mF6*$gK`Odg!Z(ns}hp~*hq^^MyNEVo90D&uZ{N)r^a=~}5_SW8$ z%*e}4hR>Wpp#hZM5+(KhiS(bCi36^mxcz?P0}z4CA}uZb=W3{U3$%bQ1y%sM*Q>?S;^$%{A|<|d>cmn7y86H@9MW92 zAQ)B`i`rl(&6 zTrXtd~tDR{}NhmjXB%xI_x&y zKQjs3%i^6v9zItY{HhkA6N(hi%)J{J{WVtQ8raHvA!S+Pl1 zyNOB@hL@Tf99!NW(CvcT3(S|dp5oH0tvksncb&tP5Wu0FXws_g|`jlFU8!QNHO&#Od<4R#l7jDpqmTxS_|Nay?6Q z#-{E4SE1X*wylj~%35Hoay^LGeI=HI!l119_fsv?p@fxi1GX#>vNW)2*1su87M5_Z z?se<)j9Sse@i-9R1BpiP9|c|>uQ^Gd`_Eu;wV&su%!yUneupIDyA{W8MyPHWCW?MA zF}yn^53Y2t_q*`e*=k^ST4r;$b&vovZ_27IQ<=v+1BiI|$bZWUlM&+lgWeJNz1)vN zoriSgu`Ce$_mYAq9dkqG`E%wfyV+O}MM#6rcBVBwU6uZgpVS>pb?50Epz?UY+G^@k z0$#$&hUcbgv4K7QNQ7h8hL40g`iukDw zjwh7|JFfjJ4Q1Ff0gI3qll9Kv?S1pi--Gd*BbWF;A!m5YhT0hh;>753ZYl~!~ zgNNm~YXjAzhbnVe{-CVuuI4U}-n8Fk@y+?KGk@HNrXEm&pfeHCyA+QPsbx7xUw(emY04RE-~>3#yc_q1g2@9`8&83lJ3dVFvZ-;Q1|IQ~aj zKprYavO%kyCzq9DS?|H)Dcch0c3-PsMxyJ|mvoeYoUp-oQ41d~#RdI}B$ zA;mW7eVAL@UeJFidc0=}0*U0rxWtiIg`@amlQn$!1h~CZ28sO3u;AG4E34M^V>Wg^m`aY zgx@t0c4=i;aPmwA^ls%iA@V8fteX)}P#m>OlId zd}R$dz_^c#_9ZXy76JeI^=>i+flxN;!09iZE=X7)Q_e8!*2NM?BWVvL9J|(-!r(RD zTWGNBJ!b&JpmkhLT*1awy$6Exv5@d#-|cPL^K}#opchqu>2Z3TItD1 zNKOs`DXN(+qq?+0R+NcJpZz33x7+X6P_~Iu*aOqQq&2@)2^nW=T#>8NB8QgpAR#Q_|)O?t83Y)+K=hVb;lv+4JLbT}nrRz3vB zr55IUv`K6cwvJo7cX{|nxF#&iBjTu7As2Ym6)AJpMl7x2KVnNk-nj6{OBb|>13#S$ZPG2DZ%TLDRnYp{JC%Dx z9y3KHL2_nkTJgN~0w&lIYhS}hd$6vN1UCY^Nj&OXRCl!_!ZPE&N6sX-a_sHrfG_;@ zL8sJG=9nS>mspBdfs+AZTub_;5?sCG^y_CC_1h3OW}fk-I`^O`*x#`ZP_8L%H$**J zSWfR$_}&UyZ~`44z5!Ek4q%(82ql-NK5dl0Amej+L@51N+yz(DiYNuVwEHU3&Hm!l z0n*%+!0PY?n+6>vDj+Jta`j{0YC7YoNkqM}1(*V}mHJC@F(LYbF_^t0 zEL!JCh_e3mrImTK{Tp~k(9w@X$frx``R5mQZZWxwd#i0?)E)U18rQCi@kN)zi>38H zc-glaz86-Gfm|$a%u!5%T!m9_7loqSXftqJ@Yq<__zJ>eUc-2JHEpz94|~N~_!k{f zo{|&eL}BpYvTT3dNm~VYDv?;sTrw*s9ws2!%hxUL1IjVCfz$W)?>|#7G6u3JnDphk z`hJ1*C4TPOwhSmZYPPE;LA2Wi^F|QsLN+?bhow%UD4?ZqD7SANG&aK*z+qIYat`cK zK)g65An2klS(9N7EN$`pQ~BGQs&JhS4*g25YT*MS<;D6*CyM3@e9&&NugIW0H;~_c2ks>6_W+KOLp9U}eK^^LoG<_k0yS#}hzAbiseG<;5-RcQSUq zNHqvm%@9VXjM>=O0IOSyvYLhKXtKloV!!iGsnvpnftotk_b#wU4sLwfR zoX=>O0!bd4XF(^uo;20sLgMqO_F^_4LrZAG!MYGwIg5RrSsN-?3&mPT6kFb;EzruD zSPYz|y8qZ7H2xvYVE@IGQUh{Dc$q1EcEQY&q>Sh6Pj5cR>8T7W`Y(gy>y!OLgsJj6 zAC&!R7A2|Cm;~_UzTUYDEHyIp7B+*q^FACfD@cso`bUAvD*+1Y{~QhQ(7Ax5?tpz(D)*~#%WU=K{fpD3wl_>F zx&Y?L91!S&Mn76uPw#wodhtRI7^Lt>RS#TieDmnPE>umFECPlON?d4)k<9mQcJuE}Kv%*z=tek~1ZHG2}QP$Nhtm@cy&@FaP03zO$(1;J+f1oP`X7(?Y!m z@BhcvTR>&GHs8Y!f*?vrij+!-AdPgXlpsoqfOLqogmj7sNC_gLGy)>hE!_x6cb9Y{ zUEkd5Iq&)X*SD5ud31?B-1l|O?AfztPprx-7_s9pZ9hL#C-bli(^fCWY{j$515$0t zb+Mktx3SEc?a(U#i|p_5Uf;=%U$ha?7ufeV=QEk?82ZSa zIjDn8;Ow47f6I_eJXW*&-BXf%cKD>B@@@J;7<(Du6I!SBN4U0%ii*FDV+;DVYQH>6M?~w$8e1@Dty#*d41$%qC`LxVh}zr5{Ho)A z7NtaKP8pPn)ndFbeNM6r$B@@lJ(V`$Oj?on0>JE!B6# z*3|yronfg>uP&8pYFO9MM=-o8SMh>*QcCm1oo^W#jX_}KgDRR9$HhE!rMOR+u+2_6 zwelgg+l0MgdrY`zf;7SoE2^xKu|*CGhLFTO9nuB$_HO_6xq?RxexQ4LM=O@@wSsG9 zUSOw>0 zH0{OBqWC${VJV!zS3DQTfg{oq2UC z0!rXw8|kR_9hW?g33%q0k!S9&LObzt6CBNk#~q9gRS%=B{WZT1?F!XXu^tfPdB8aD z&~%An9OZi3dx48su=~pMIs;zaAx}8Y&%WAwzKy2T_8M1A-i}#fEtTr55b1KxvkNpG zIw`B12kDm6^22DemCIrJ^fa{8OF{qhKqEN*dfkd1atALR_9y^JsJURp+3V}~RuEZI z%Y)k34|vN^A2g9+cOxnL4h}deCWC$XtF1OcwuzOwXd65c&<*?Izwxyka$4r=x>1l{ zw>2YNMXS_&hiO~BhLICs6D~@p_ho0XgE|3-73#MyJ<-!amIx0TJLT{0Os3QR*t8q_ z#>*r~pOP^x^!SYuAIvGsKs(|!H0MEl_c8ce{~E|pc^$JvU96|%9mnzD<%sJ>r@O8_ zcV!^cA9zId?M3jr8$^51i%p^Z;h;aqXeQ7lTYZ3(f7#b)6uuM`kX%=q&^GMu>gpI7 zpo&gVc==t0QT`m+NgxX9ppXm)Vm z^So~E7nbnyIhFLMWhd$caN2}jgW>(Xn#s++Hu|}?sKE$-Z%g5v?h$lYRfPt7Yl?

Fx z16yUhAJWDTuZo+OKC+W}z=B6<-6s7C+Xb+||DXFEqTW4d6Z8E~2#B$UNG2IT=7~^P z6Dx7=_ZMGop4q3w zBSu%Sud7-&?vgp$S%a z8UO}F)^0_i)cP%uCA!$Ovi16-1hwdY4TETD6in*hkf>I=3CB82Vf!W?wp4&;bKJ=< zhO(p0mg0lOba*xhQ!_W$;(h`m_XOCh0O{yg>1pN3Hrvs>lxR)9akspR%Inkiv6x2Q zM?a6zPe0UP@yHI|Zwt$;65IZSgNeSlxTwQkY}x$HI7OMl zNCuaDMc}fw?Fr$Dzcj7TiA!t~m19HLr{}NmH>5Oed>pZdbGTyT7=NbSVKmC)6{bH! z{{EFd_YXe1SxUUeWJ_ywk~kdw?MWw>&FEs?DiABO$x`JNGbV+xS^=M}^m`&;j^SAYSc9 zP<*!Y7hzu~;$}XX;6uImxE8FvbDXwKM!*jouOHhO_8>?}Vb#>K_=i{w z=AKnhP$1(mBV#R@Aw=o|UtizsLp~@Lo|&3*xsP_}94&o(nCkT~6&>|inF)S0<(hG@ z8wq6gFR|QxwpOg3@tRJ0wsFOc(&JIRn{y*KIWBBMueXv8jaNy}7=k}R>)N$sxV2d> zy`gUNWTZ0{1}iD~o}&f_2j$ayEf$nK8u)JXb|n-&3ofdB=v5*&PW44x(+2A`{&r(n zo$l=1FXcE}ff$KZp-u)%ml*M1*qE0ik|lJ_-7cS$?%ryZ(#U)2o`vUS?jYd0hup zm69lfYH(5vDx;pfV}f&Gr*?1_kCG{?agQM3&4QA4R`*V*dirI>(aWf?{vw*SXWVV~ z@vacNa#CS2Ycs$S3Un;Is|*Z{i@OKaL#bmyd2-DQM0t%Oe)CGZBgVJLv*wkw8_l=B zcaCCdl82o?cdiQNu)L8y=%BObfZ&0Kf&tKKWIqhES}q3D`}^;*TSbn4DfRUBP692S zQM+4mdUD92S9cCs)8JwTbqp1OA#rh*ov+~%=NA>}k5{

YEghBg3p&S&h|RSU(!Q zUcN-oTr|H8CWN@zX+Uho#>RZE2e+D=n_C;H7P?Q~aX&Nby>=T{{8>P$VoAE3^X{sI zrY04b5wt2%9}cHB2uz##O2axdF|nYlWnJM%bgq>tfIQCxzxQeer0#JmW?k=Ilxo@FLU+s{^{ z(q`<;)Y{lt@BDZT+n*f33b(Ur;Xg{0Wa2uWMSG8Ca-HbKaB%iaiUbByzoAMt%CR~W z$qzWMEE{*=6k`|m;utNTS8#{QBZWst{ug%ku|O27hx(Hzi1Yl`M)e3om7pkXS%w^( zExJUxlqkhq=A`80`kMzc%}X=$@nHt?^U=BdHnUaZ<5wtn%%0C5rN%m)Zx`CaDKr~= z+1e^wI`=*->?%F|S!BNgEH^UQqI|-YJT*Oy%=UK3Pis$L);4`&kbENAB@;w56M={pD)M69P}be)LK~0$M2O?U-msCxIouwdU9pHr-n{2haVO)C zeKwlylTjYyns0rbjRL*Z>9O0jIv1Q;ofo7q4$|HVxtx2`OtI1K{qDJ=WPYMn>S`Ii z^H>*ySGCT2!A{o$7kE**73YjT4E-p=h1)g#IIuB#LvygOKeh41`J&}dszw$r!i}n* z)5M(&QbsZ?Zu*xFat~%TvLYED$;(#_GA+Y(>i^Dg&?9VLfiQ151e24KaQJwGlLn^3 zo1ehoAuOW6YHn%auo&Tknj%L#*dF*Qv$3+vaL01Q<`6T4MkP66?;js|cLlDVC6hV_ z=RYV(DtL$rxstbU-}dOW3Y64;^tJWZ)Q*8AX?Xec&YO6C8;wx9kBut@orBYG=AByt z?qAL$s`)WjoF`XZT@Bs3*~VqdxR(Oyd9E}*(PnspDHc~qDdJ_b;#7xw;jV?^ zt9tDXb1SJhWv2I!R!4rn7x5kGBsA9h!PSTR3>#fVQYci27<#;-Df8m#uT(jT3oSWM z=cKpH+1%}MmUdKh29IoQI!zS@DMUGO6t10oHZhY@aGYy%?!5M}JhL^{a#uR5f4G(E zY6|kDR&yWXzAiGwn6Fl8t{ofL?AFGb%La0vBsv#=`M$^_b@(X)x9Mi)ok#jN6Yrkk zpl2LOXb(Fnd)O^0MWaID`{qF9aV zN}ijW+c$7KbJP~|jq#kY{Uv^^fP@%6tHj#L7q8Mf_H}N$EvEC>u72ZnpE{Rb`PA_Z zgSAvF$>k}0)Mw#-G}H|dn>O>|)Q@&GCT0akmuLNAvNgVsMI7Gj7%ke&hKbz$1w4`wUfeGkhYQ4;Z%m0FQ))_=(2mzEhn#DTv7w|6bD9q1&9-0D!nqF7UbM(V1nLid4R*^c)P!N@k=^8jFPlQ zaWy9I?B~Aj!=udPJgJ%UyThm!uJGuQA;)ocrL3T$mAuS8xw_!`gE^JmEiU28rC2}Y z;pOFIQ=T3a4lEW6Vg_P5F)$nD8IiM_E^Iie3{Gf1X?$nIxWHv;l&0@pVISVNbHJyc z6zHY+DA1hGIkUXq#+kD`%c-!I2)(ng^@nf$Xhcws0Cf^>KL7nzQUx!QHhIO>rXqG{ zx-&L&ls;I=n_F8f=Y7!|YQ|xGN;UF)9;K^Hwh6A)xt|_tw?^|5tyLUm-p3s(bL4s$ z&FA?MR_ZMlf>J-etZWHu`3=cU#N$Bw^q}82Fp&H7@NoPTuZr((iRHM+(bT2NDu@hL zEi6Skn={|{0GgY#wkM6P2&&=Kla2E1hCKv9|+G}1FY>ryq@9Nu_QIk1nO*hFub+ef*OF$#9^8qIW zJOPd;GK_0CyXz((Mz`iAj#W6msYO?$!Rn<<{xlL|srv`O;q`}o`TV&GwpFnNnU53` zgwm<4ytRk6=5&Y@wN=_35MD(|OlGV?g3#O8hLt-`u3zKhue!h#KWl;4SCVM<)qr=x zCXo~2d~LUszC37*Qj{sGuvr*m!+gF#jmz4GL;m2t-}8fw(HEY}*s-gEA?JclJX=Dx z6!q^~f-DNDB2fdrOt&{KM$_$oa9;+ui-~A26olhn9bl z`Glhg2?+cqz{V><%m>smgHs6O7_XSd{$f$te_B^p7tiuk%BwN9?GB?H^XOJs=1*tJ zWEG}zv#JR1pL-|1RyVtEUe6w*7@S2Oq1M&XkD*wtz8c*0jFdS;w+AR#Lr`@lff9{} zoIFl9P!lbQ=Y33>7$;qmBXDP(V%`zegnTqOsvXbNH##g^yWPG@M?c;p!URI%hJA%T2#(w5=@D42>2

    >1i^V>2aMjvFT(6X@nC@)xstByW=Tw^e=u;kv3B8t8v0p4-q?F856mcv-Sm(QQ~FF$|E;7i3A@#F^f+JmWsD(|RsS2xK8U)D#6paQuDkAFuHitXyXXl7 z@~Ll2nR$Gcu$FtE!c`Ede2aL)>o^{;#IY-0a1X4_v3kSYa^vRBt)^9Hl>LMfVKQ;V zS)q4=n*p9=w-(pV=5j@UAG?ho8M3Q5Wi&PtplVinN?2yU*wfO{3w|o8^CmUH=^e!pYCeC5ER5R+}rs@2-X%7Qg zk2Zqc#UDJt1%S{A1|m{dTzeLy{fHP~2?aUtm_t(O(7p5W?5OQeLL0NV^E@66cNl-l zD^lT{bdYIa>UA{rUNA7?|5)xx$xgeL3}st^Oig~+ISp=Ox|C#bzFQY(TH6WB&EQ1f z_8r@vcdY0BY`IYNAl)uuRzr}+=YW=}&ie6F(Slo7;du*VCZn$Mb}B#qvK!|)ik0rH zIHXgcXd^WiJV;9rDLBVhb{OlYo*`*#n?E`XxcVY7aZi?H$Y$hI=+wvTqHZULPGl)0 zXfh-{YQ#UAOa@2zp5yG(Iz2ll9J}zo#4kA{3fCH`K(V)wkm%LTudEiN(;rxzY2I2#U&&c{KFly}~#cbPXVa z()v;V`S%zjc5a+nCz%*lwP$j+AXWP!WHSwNd z#-5bFT{{2BOWXF@RY`9wF&B>L711G28-*g zM%S(pZhu#nYwo_ktIR|KE6 z3JMfAxQ8-nE13T1_2}60Gu2t1Md_%>r}uyEDlEGwDbS-Pa(|JDdt(ArJ2!|Tj{Rb9 zV|v*5(OSw2`5xHq+a~S(4h+69{QOQc=aF+&!^$dW_(IKDlK`&dA=~DI^n@%f5_2A0 z@((z+oloU{27P9O=rmzovSg0#@#HC;z%MdkQzhdbrXx;gI@CncD8p!1Tdexf_JI44 zDtUEZd`}qNbWTip&-*XJ{T7*m+=8R3YusE9FQ5jVsLZv^?tCnQCxHL=3EW{^d|$0o zMZMML92>((-@*w6=&0z8-V&FrK(1tBBREa0H5A8k@iHJ`oyW%00EHraXJ*TSu|s^_==N0OYlhDbDttK1{#{hwtTdzNADy* zxQG8rb(@_3oX|u~f(aRq;cV)Gi`)MR2P!YVIB~w0jErW-2{jn4nVA&3$WeF2Twrij zu`Dy$S+i76F5m*X4rMD14GlSt26>nXI6kqt@855Y*yUg*5h-UGcz}~rdC!bz8~H=ED+W0Y+i}n|HV6?s%o(-vLDm3YQ{2(j*<>- zJ=qO{wF`uDi$xbwFF4S$DOb5oy%@)YfXa8tNQI5>gRU&{UfHu zCpoq+Jb!pHs_{hH_b!!eY1wPmw`DBJxVnEL&!FOjAazZ+(DZsKPZR$45HS?$kXU(n zq~BVq`ENSAl{vBi`lVWEC0K#wMnXzT!{SbU{wdP~&rMFfjg45P zJ@(4hMf+=TE;ex`vblYlQPXB$e^R_*7Zh%oDhX2IO-Oj;b5)ePOK&AYlAYydtEd}k zu9?S|Vg1PP)gKRo3)N3}IaqP%;Th~2P_a^9>NUNB^@eRWD9rOuz9_aOQGN8t8=L6* zK)GgyN)n*6pOPV*`F8UPJtbVNw_C%ymbUqxPoRD|?c!0NwN433^wX-COB*5B_J+T~ zh1NaMMtqK%oznAuJy*C-F9@nX&0{EX3O~_^aELzcihlPd&RE- zd5pt!h4C&=+DDoN>f51w(J8TQH_)5IbNT(4AKOSxar^=J5t(PEr>CvfC+?IM zA@Ut$4kvJ;26FYl)}$rFYx=A3{np9h<`cL?^&b zMkb1UQ?*_lJt?*K$EkB}7_81`x(K(oi1wA(vQ>Ypa_jlW1N`A!;i9H|lgz~<&=Yon}^&*MxDKcoYBKb+Z0 z?t(O#l5pCxf-Zcx%gg{4A9!8)#H`7kTs#Y@B}^hYls(Nxs?^=}iJ3x^OQje0$HcqL zOKK}3V`?*H5l)KNQ$8q_e)~~)VB&rjHPO{`Kb)M1J|LG~-s)PV{GVlmYH-VMaMf ztcF}H;}?jPmEQRJHpRl-7|3q_rs@ciepjAQXOuC&eyZxy_65pF=Agi56mYf7LP^M<# z0Kpy&lg-zoKbyaCOZlvo%I|M|t?_~JELp@7i&hz#|0Om% zBjsRZQvvP8OeJo>c z(%bvp`s%4{ea|P|XZgpqv zhp`Q}l-^u9FVkJVSN8et+&^*Jv&2TD{mjqum{b+%$Z$f>^y`6j0iCrQBQMkt0?|@U zSZlxq!((IjZH*E*4O22;CR+->KnVb&Sv;XrfHhn%}`!Dc%_8f_<z0Y0|Ez$X4~} z5-M|l7k@zYnWo36c#=v~3)?b_jakHPxS9l%73W_rDX5YZC(O`&f7}qbj%;) z@T$JOEm>HK^=>UK<>Vr*Y!31=LuI;~3sSEze;DidQoG;oGQ1QY`W;xOqx~dTmByRD zliZ!G;E>Dx{5O){>dlFZix=`~%nLCwormSiSUMUNyfD8RK*`@VMJXN1ZqRg57FKD) zHhLfDCoi|jC3Zz<2 zUv=po-kED-M~i1H7JzCPuyqS3;TKD zE`)z@vX!w@P0_ep3mPL^VXDms`#x0vJ6IY$P+)oq8ct8HL~tdCwfy?v8x8%uzsWLE zu-}%=K!k-pu^o-Es^kv+6Ux!!_A$qe$vb4E%RW#(VYN_DIWf!W{_mmzX%Y*nb(Jiw zz*A^{&c^Hz5)!gojtPxCuf>i2!sENLz@uam@2EE{Yx96{wIY>o_NTL(o`1AWsR|*I zp(9H@JIC+P8`+)aNrciFGoBl0exRRG8YS26njK1akLe83bqm4(78dT1iyS?LT2Hb z+S?mJU^KH@*o7Lfso}eCq9J?ZHAb;e$U}v1cH`5V!pRCXo5FChx+jmX3h-Jc;E0TQHmI!JJ0Zq7(#b#Bfl`F@1nLRa!$yZgy>p=4Lp!WRY-o{9Dh zmGqFPs0Gi_-2jgM7EIfDe)eQKnL*cfqQ7+Uw$p^M1ONBR_l~51`;}TU~)1_c^0LGe0Ek$1No$XAl4Ak9&uQrNpUd>~|@AySFp;O1_TGvbv)GpLaF~TyVp|_R`8&1*D2kpFS0j+#pQSWYE`+%9-`} zOfv^gd=_ly`&~)#mShZf zna3+}Wk4HQ=*Q1HX>d4%wtJNJHe1+OEVj0`Y7yleyw`8Zp0}Q#52A=zH4HrOMd#Sh z#^mX?2<%~Bm||#Vl%j?ua0)ZnDao7AzSWaT+psTJWeCRy7Sb`a)=Sa-X!^>=$MGXf zV1Y4ELI?9n$TyX3+n8h)yq{*=?67mM|eCl1-3lVFK zfyQq;lmlYnQ;rzv>+(aMs#|oBaJ?Cx$@=`WssI5&2m`;+jqPCfBXq8`s+EQYSgUeEBPe`Ov65QVrwj$|E z=ZQzy&ADx?fB#)dxa@g(c^fcII|Z(Ndtf=9WAL5u2r2`3t^|omNysnL&&+=^8`FTL zHD`Xb>_VcF9uiQUM}h?rbgV|5sF64H%hc&5opkZulz)!(PZ?!p<%w=N(fWYPT-l&@ z&~W_ue$|8)7uDV7oVY0MsP5soPc4=H{*&phFsT5P@7Ae|(v!Zum^E4jH?SKt_fqJ* z@eT6eL@*csl*ukHr-D9h)v#q{Aj^|N6be4q=tjpal&#a{!{$XaKuC4)ew8_j|4;*T z5VBvI%H*88_7|60%Ku6EC>3<2l&pv!a=Q*8Ha5cEWiBP|$JypfQ;>~Cw$F7(aI(z};LEmsZ;k##Ukx}t0s|wyC$F;VxN$BJ& zWBgRB3LG}_+z&f;{&(0c|K@Olqymk^OG&tOZ|VmlKN1LDUD5epTKZ*gJl7VZn)eh} zWN!jpSw-b;Qm0N^G{0(@1Bcs&zxGx3w@Y1EA72u^KzT?5Jxm^789u1TP6l4F_!%k} zq^&Il&j?2N6fE-HNT!3r2)6tE_q-z?VQ_&%wZctwY|M>vFsWvJaxDda0Ef||gx2a$ z$_lD|{1Q3s4FQ+EjJs1NVboY0v z!Q?7A{Ude&;7xl(I4ehvhT_xg7l=n!L_tORPs=F_ z1A4+%d;9y7mhOiX(D=zVALe1!{6;)Exq34wGBWah(82s(>w`j_m+QS?feRly1YVq)np&(G7V0V|C(>q_b&qr1 zxeOHNb3n{PLZ?7aRgIL`{2r?SA&A3rPUG8{n7{}vCu|R^@E*i@*5`^F*<;NYB%EAa z8#}|6)4vwF_kMND36I59>$FQxca_gHT|0MS=h6_VbSQA(GlegToCZCBIngmqh+P-} zHbtYE;VohKT8W^&c#z(2uD|F3S=!l&u{(_avTw~6ei;9Qp>J5Q#-Uf(oBnvZ;&3(Z zP;d6<&q?I}_;`%kD7QS6KqAA$#Kdme$Go)y8WyG0hZ0&^)TFE$&$g_FhlV=(`nWSn z5)#l5nI8N=p`f^gAGyq8;f7l!DbrBUVR|LBBT|7-x~MBfhgK++CHWPq{%5z?$#6&; z>7`$)XB3*~?@pHn_ntvruQ$HdlG`D283!}qiYQV^gNo^=NK}v|TbhJp`SE2dOrX0m zngrDYw?b=$yBO@t9~No_SH}v2dd0i#xVK@q*jFS?naO`-yGTxWcpf*4=&){?e~95p z;~>M&ZALCGBB%1PDG{%7xkAt-^)+_uiLEclRkf!sj&`N80oC5QeW=jcvF&UVz;m%> zHd)_J{gcEn7Z(>=)uMA%zn|--ZCs@AjB?6UItJZt*GdD zA}*LHA@2AUu7|CSJto``85Oj(gF$cbAsFlISzX96pg_QZJKov|3mc$a`266PvDv6Q zA?hM)e^P$FvO^r`<0jYE#b;hPEK5622#;h{_4HJA%p4W&EN9Qg?GFa4`UbKY3pO5 zre)Jkb{4{j{Y2fYJ4_^<3|()oIuxOHA6|aLNPDKWk%*A+A|auk!c#AJf445W>g^0L z5V#^FFa#m2n1^%Ru4kg1V<@S@LUBfYz7rcjpkCkIZG4SOu^cPS)F}& zG1TvP404?cA-yalybo2L6=PhQ~IxH%xB7&;MEAAspju56` z`9eOQikg~VWF*Fgi$_-Gy12r3XyE8FAg`aZ70NXyuiW|SLZhU5%-X#;JCgnZs<&sp$6sqZ#Lg_7PbWAcLa-p76Bkgcgh2F6dgVNwd>a#rlMcJ##|oAsdWir8@5TrL$PzP zwwlN{Q2Y_WVChhL{Su4Xq3URR&HdEb z3^Wq$B8SY#QfKJj5<^{tV15*t)FL8)MYOAk2HEXo-v|*=(n*A}v zl)oDWR1e6EHSTuC-AViWwyHvI(T@5*m=-fxB}3gCnX|E(YpVxl*&^q<6;vO^Gokmh z?N-zy$nyc|A+-tbxJzE|Z<}gI$CCXeM6U4T1GfWI>l~n;bOF~DBng6GQ&(gT>Rzss zUH8*VMWc2U5ZRE{bsz;V4SPq7d}Bn93DQqeoIv9zZIcqEA<7` zv;GBeYiP}A7i;5KDPxfKh*KZI`nQ9jvw9=RCZ(tSm@MqW9|~2hzFxi>e#hRgX$mooigv41yKnaiKWAKXU;uC@A`CqV6Z@HOd z&GZGn=LY2Fa{AvjUrqeOEuNO!;-t_^-L^!H4X7;c%w20NSO}0UWP64a*gif5t;%izop8pahLHE5Bq4KE*#jM5d&ieZEo}L~kx;M+> z9`>Q32x(ptaP)lpTzU?Dd$#WmlYa6n#(3tL`_<49dUb zcF*@5CTdx9bYgQFQ9G6AWt?_UkdW&<`hWgS5XqF2@~|;6ajv;YHA92;J;{~ph1bq# z@bM6)aa?<5(XYR~GY##=Jor~sXQ0@5rc$zrCnKiV0 zd6R3!hi}Y$##KSsRSA8Or@Mh?QCHmdu0b_UKt|>Z4X+8nk@m%!0KnkF$fpU3-m@}% zipUctWt9Yhs+`@JqcxRLgKc6^lLq}RykISI+c!n;RLv`4Lw3J#K=i7!C+{vR=T|il zc@b3=(kz*76D0_|ThfVu^A0nlPc*R80mkyu4JM|Vymk?P-P&cjRfnJNAFl(cfrz!L zk>~ERZ#@FJ8pf);_M>NKpVBcfOsA#BZtg#NO8$8D7D%_3$I2<7zjSrX{nV8V2eS-@ zea>NHS0_sNulFd)Aza0(#m$oMu}KV8GuwykbR0y;Xo;SFqSZ`Oh}O93O_i@z==ee& z?{7Y);pM#~Xun#QQ8e~OxAt|E|LE!7bTCpsBS5S5BQL&b-`8rS7=WzlPerhzkfsa* zaH}Vx&eN$XlkRPDH2|Mg_cgIeXM;E|O@H$2cZ-YwWe|XK7Dbt5 zEa`e53y%3i(T3OMsc5LjvcBGu88rhprsI1O&JTMjLNBIjS;1ZS_*b`YaBw5Y7h4-c zLqna)+e_Cf{1FbXGf@KN0e}uXNiKlHPyYT8KYRlqA4hp0`)a67jwdEIdv%nRiII7X zp1!_B053m({^WxfFy=6g3qY_WFL35*@bS1($1A+X=w$cWU&eFS7#XoaC8w5kWnisr z3(unR*iOTK^aV6p8jv|iWQ_t~Q=Yi3nhR_?h-AJy?&K9TcoErEQ(IfZeYWx$`BDQl zNh_-j50Y12gt2-*X?P}}{0+IGa6o9yysKLF4V{VC}RUAO3u^cyCsN`nQq z8_wh4fk`=PI@s&2!)!Q{&etcZ7jrU|8E!{8gvrk@NPCn@8TE0^MGU`f?;ut%x| zZ9JmI`f&)dRV?K1%d9vsF)%XH-(4Lgwfs6Tpb8w%RRMvaDYxI%h5Rb>C;Dz8(5BNv z`z^RElw4MBGPm1Pk2*{*!G?w=5iNp4(Vy-7O?iiJ)eDE2YZ~8pE%lf|xrG1nsQ2DE z{DzzlPbt&PKyTymWca=~-Am>c7(}ink`qEh!MnN(c12ol`-Y|cZHNTp{Dlh~HnXyD zb;YHmrU9?ife%lupAb*+tsC1gaDO*6K-9yjjdj6MBSU4n?}=qS9I(1ex6wWf*}gTr zjK-0)F_qVTmFZST0&k!8>A_=!v4SYD^@X=@Jprwlhk<&{Of=|mVfb@-6I20{!9K!r zv01;sssO>0i);4z+x=a_?>IWIAxBi~ePE=>he{=a&WTGD6vzO)zdjV&2v@GZD*_=I z>9A}7c>(%h%$%GYBufww624sbo&3Mj?`}Y(mgeTSQBi&rmSqH`_G>T~BD}b? z1Y;k;^!LMcx;{xG%YuOLhn5BJ1dK#;1T%-KI?MIl5w<1ErwzSGGE_jx#=?RN`!}+k zD?z7P1{m&{g+&AO7@tqoVbfi|PD4kB0bv^D0oWVpCiRi5+}y6oQ4EkqO-)Tg!-^qoKf9QKu%>JG zf^iFq%{B7VGL_%eTm8LwNZBLigQrF*2%j7JEz4t#VWoiX;V9n8P|;r*Du@)?Qq)*K zEz|+^%ii%&T=uh{c8JzH-}WSD>~YDj)iNML-+uV;2F@fpkR1@K@7%k04sri8>16_z z5z~FYMVlQ;2gH^Mk#Qmk(7q@}BYUn+4I@C-=UdLml!LYZf8M?_$F0^Yn*gnA z`?cN8txi%Nd}KEty5%!;ebGnqZrw!7 zo|fzOBP2J?+E6=8paD3pJKF9{lFBh`A%*E7eS`%petvCd`S`LF;cQY_1qn*0!#=(| z7o!pXQbJ0?<>4Lb8VK93#C(FUW))*Dxe0ieO_9$Vu4Oqdca?5|9J?Cmo@cu|h=bcl z9&=82SLiPM61dt_io( z!*P9ZKXQOZIU*H77=472*0dk}sYlP=-lGlKXK&`6 z+&Vn3YcQD*EWAS&>we;h^yFr3Kqku4APBs`1~PAq?2vid9vc`Qu0l6{g#RpGb30=D zLBS38EsL;9N8Vo#3ijGRveDkWd7;F{-JJWKiGIS*SA>?+iVxD@#6jtVUU@jWW;O;K zg&pt~A1nJ7Y{>*{Kbx|AavN4v4FXE5H7OS@M?a)^o#3m+Hr~ljQ6(g|w07QbSPF<> z4miry?d|xNv|Tvdjy9y=HhpN15^)tkd@v9m4Z#%%iwdua`10k;cm>@$?C}*9T1~7D zL{s^Z90F%VDKn~-;}#QkV1|J5t$Z34(`di?-$I&_S~${3BeS%q60QKLc4|tB z9+YnoLp>#v?tmB;<|Qnwf+Q&dUmc1rZI%3G7D1KV02<$jp)6Zg+}~|s1mS_`#1p^* z4J36G!U}=*e_XZPsi6MrN6X6NzAt=axB-7@N@3C0+g5|OHF!h{h*o1Qzd}x59?VN^ zpF`>mAV)ibN&RgO&ob^!KEv%>74j=(yX>Vac63-lRMJ}J5?s0lNEVx8?7Q9^g&QZ! zXkIM+S=0$R384>ub?2Asl$mCn_%Z|p`?+5lR3g?)QCHDa|Ma#&BJDbA*kNTXzZhi{ zd&kg_{seTz6R=2>E35Op;boxjDi3S9@B!7Fx zg?6M(z`gbPr^eTbpUcpYm|x09Mf*)!>j9&8o1d?*%X?$23MlxI9NmFhx{nUpv9>OC z$}jMfegVqEk!a<#z)i!}*Gm3NA^`|Sf63PR`C^9rsY|{8+xm7UPreGz_$(&o)bZ|k zBh=iNkUAQ+O<|$v=;#o>ACOQX-!3w9AZPlW5&G&s?(di>s24wCA_;x>&YOfLj1Id< zJ2GHA>loYe!~v&B^DT4PSO_myZx~^@i=6Fhll^a{m((ck6>_9-Y+ibzVEe7w#B?*3 z9)OZIi|*QYfzrJA266neZiUQtZGTi)9bEQGp)~~QfbLw=e_+!FEw%^Tq_;7aZ>EEr z1Oa!|GZYeFQ(N#r7i0pw+_Za-fAR$0+2Qr9!%PGVWx4;m!wNd$TS_I>B01VO?L`XkU2RxN5^KX-`# zQpuGW_C~BhtF^O(iGJjdGKb`w;A;T88FLh-pE8az>lg|rh>=DcTIrf!8`b{x-`(HO zsT;Hbg6pmuHYJXS8)GuJBcao0u(kV%BL*tXFCVVjkNy3gb#B^&eqm#vw~xZ3{u%nl z+EU)dblg|vF9nd2JHFRU#d2~pz6Y+kC#5L44P~=2HH4I zQ96Q2Iavr$>&<fS8NLuL{nFl>y>(&7of&LF%&4*Y2@SV>|pT z)jM+ef;5yOMVyM~uRBsDw}ydQVUyc+rDOSqGyT*5UaQk3bYw|lo+$$KBmehCg4Z@q& zRwE=LLPkC&pg?H=bK#MGMe9Kw>>`l;o0xo|33rpk!L2Ib-*6CI;{#p$D=$Urjz>x| z%kg2M)>0L}MInM`4#pBn*a!pMC-NVk(fbPU$B+m$8}yr)a4r#4wTKq}Ku%u69I7gP{QWtLz+K}d`34Y^{O8}Vfa&tQhHuK_24=tH zQB|Fb*CE>4NYx-GJ7a_@)9ht63g^mVaMN3qXND4W#8Vkfn;+cB^xX!q^}Ut?y*38kBa&K2yA;~g1Q*+i2W&fMO)5SpXAX6#a!Md@BevoWu@R;6<3ZEN&@%`Bd{Fi$FHe4%7kTHWOIjBFn_OmWj+1Q9I zK-k8J$r|KY?2BQn&eu`kZcB!)6VaDe~D zdvg8KrV=(AC;2a62nN0rNZW)t2xx|V#6ff&c^D9Ta)!z8(G9I!`h-G(AkuTlX65CR zY2o5Sq#WUk9djE|e!TeHP(N#K!4Mq=976XHx|8i7mXuYRed8>9}b-)A%1@9Qqq06~x^(?Kx zyzQNtb8fRC=SFSpzg3U`OnRnFsF?WroY{NM5?k)Q2`~I95Y^PcJEyHZ7L;s++vb_Y&H*21GYPg-hJMSsuD*^UQcDyD3JC zM+a0!A0_&5V@|b>GkaE7P}!g)iP%(#+l!K-`PDk=+1;R~n3VK7H#QTOb)}*RASbkN zul}9Ag{VV7Ol)8k1k4=tX-B&5(RAK2A+Zn^y&U{?IQac|#KZw(QoMqH+$5JO^xQ$W z=ynAVNm<7^^Q$o4h9DBCnf-@hWJvvo$6{L1xyXzt`u7`JV8G`!;#usbn`f zS|Wlm5csv8p2GUjVIdzc#Tj!_*`P+7k9gAt<`*h%e62e2qZQ{h?$8T?Vx4B~x-=m` zg!)*b7krAnujVa^9&zu8T!poE!g$aq&uMam`kf}su%z8Rnnrr;dXsh_MJmG?l-8I! zj+duWgQnpJ#`-&q$lt`BX@fl;LM^y1;f*mQFlxN&L-!QJkBqb!H2-&Hc}Bexx!y!^809|# zqm{3F2Da!@gTUe1!)$~VZ?w+mKXgYDN8Hv(Bx_SiQpAF;xBAIG8@Q)6@6fTb7ZXBjBBi ztSm@MNWzTryPR-f>aHq@lev&pLkAJ z>@460)vGSl49KHzW!#^2d{S~E-~qH!5#s;6WKb7q7U9@awvyrsn{Pi+qZ`}3Xej6K zPRkZSJTQ-(V}eC`Aa0_>dz-^9ih-&(X}#dyre(AAh%&wQOEvgKRxbP?+4Swe(ybjg zy=Hln|Cb-pSL;3ZDaDXa7tVPI^e)_Lorpq;?>)Cg*?;IH2t<~R*hZ22S4Z@SN@$&_UNbzDkA3{5waKQuL^D^VF*($_ zAZKlr+zrfYM9(-5X#%1SMeAxyP_%@GhJG)#5|gqUJl2Tv__-wTA|$`XHTsTVzMbVJ zqLj3N`Jm$o?Rzuv-O?izHzn8k#JrAF?gL-T!p7v=FpvoIGncVxoCe{Z0i?C)951d5LnPvRvCR zR1HCx!uU41Tc?rIk@{e3Yjpla0QnJApIZqf^<-R)AG7#Dhz8XF%xbA@3?DLICO0LJ z!l-+kcK8sm`?~7-EUSBB9IhMiU+%M!HG3*BS)0d6H*EsU;{UinM&5Q9y^M;wQgRl5 z7yXQJ>qo=cvN(4_du@KK(@YvO+1$q#D|q^>#fLo)id1q5c-pS^Yw5YB?0tJQ>8^GZ z)!;`k-`iR8?$$1lFyTXe)%Qdv1-kYh*41)aBkO{GJy^QPfKqLv0dCT&(9$kDW+S7X z>lwjp{Kl!X28?0ST|}9cKb*>76xz_##6itLyr@=eO@|1hkame6Gi@Av6gd?YY|s0a zd#?f&C-u)(Dv<|k|H+c-@7pr0DJ>`ul(_HH>lRtQ-{+9FTWN@(>Iklf>}lYp5q)eNMXa z$s4kQVSZnKj8ww|B${NfJ3*c#K=!lTT`WY1mqnYy&S==FSi_42n}CXfvs4d;D}$_@ zU&5ROmdRcZX1IT)87#qx@uv}kY<0N z(9Ur<3ZMr;{CLeopm4y*-Zan9(o2_5L#ym$#8l7EMlCWw$M|vSJoUDJ0iM;}o%liOapm<3Wmmr^RX)+_@ za;1{>u?*`;^N!K>FZcIMl;UsT#6VFJw2Ld&k^(omY7Xx?cC~prCs9n!h_GuzQ}vIY zrqWrq;$H6muD}$Q#Hv8 z>U;72ev-XS!{vLP%aRcK;x-Q4l`lgbqxFaH_@|HGZF55TFt}8CbQ#2rTB^J!(k&vN zKy%Z`xNEGq#d~+Xul#iJ(acIusS4#l|2W4<{ML#Y5EFf7J(XnGiZS}FyaH)M!$F(@ zMGVrkKk#Kks_!HF(gy6b9%F!_ShbrClFz1avkp4zo18ew$S)$vm4s!oWVCYFHpBWP z^2J3VofhgW#Mr1i9U-x|_zoA)NO8$D)k|MS`la>}B|2Tt1o`p3=8N{08-iKN>8HtJ zz=--35LkDQ+do`>A+7Qh0E3XnObp{-e*}{ma_P>et<{OuKE1#(@CNQ1x2GwlWCPI@ z*_(iZ?#!jzB5rOK=rx3+cq5oL-5qqOJaKE#RaZmDzJ5KB^(c53X2PH*ZumB;eq=Lh zjqucD$}M?E%mPZmizR%1DbNGJvRN{+{Pjtmq)neerB@Mj^~S=v)%$L#!F~ZN7elqc zty27lDueY24R`EUC6(L-xOW9JAAf4QW{qt)vIg>lnK4C_M|Z@j*6w*v_#hW9Tu{w@ zaN-9rC6J+1R>jU`XjZSl2e}|9NQrzdV9HE=p8#PJ35P+mM_e3r#n$*qA}INgX?Zpb z3x{W*J1T-q`$rl>=ucBo1spp`q8iQPw&&o#1{8&9+uepdm_kWPHpcHIu){`xM8+33 z0%iHCmL{QD8KQj8TCxA}(frC^%Yw@My=wGg&W%yjO8cv?$G4dMw zk>1{T!uHMhPH3}TtF#Pm8PvUj3ATx3;X8MU;4ve>yBiy>f3`GG8Ko0sBVP1jSIZv8 z(?wHZ>Xtyth=-8@GEsv$z8CWRK^ooBPVW&2$?EDVT-aCJs-WG<+UzjS2Q|fXmN2lY zqTvkiplw5H9ieBz&OW?`A^q8=shPGc#-0LcKDOzvN1RGo+?5e}m!2HD6{!H%e)8-u zJBOoqdXC-*#_g8d)gL;7sN$Y+TxB|Luf<8;X3qay*rkXRU7s+NBQOjvVetLFc~iBq zaNEoYT=V`b86hXX!THy zbE(Jy#HQO>1c{pUkvGLI1vJa;RWIaBZ zYtYhzxzB@p1rhkh2Q0ZS*@FU^%IOy*gSV|pp*vZwwcHLkCQM*RSpk75wZ}M}dq9At zL^hY{A`Fs1aGBDD_gQGaty#=vr|Y514;#LKn1?qsBBt)PRrRG*1eA8Be8Hb6CU4xT zAVjAu72D*?4sRi1G%9WSWr!($>gA<2X`a2=cut$%Vm^ea={O#jR>bt-9YCJ{p$Tq``(5?eq zT8Z55szAk0#O1ZQ*U6ie^2)b|MMi%8!HK!-vZrj4AjB}ylw!KiTWuFB2h%> zdgI0sWXCgP-NdXMxQ4XTw!cj&*KaQLdtMOrLZN`*6cil%q_b1uu8K-jo3FpWsD=gw zKDE&EogJsO)&GCRraG}>TVvyOC_bRDFceA#)e=CU;hQP0IkdZ6LtX^*GBuGLhH?rD zxgowL7hcKi+atkU3>24)u1xY`Nq><4kT?pRau*xEBW{eT_r!HKR z3YpBEFrx5nqRa_N}k8`*OkVH3jyn+dFKno$o~ z%14dj9`t*p|A_I%Bz{peKi;ubt*^&yh}D3#x6y)bxRO>?G@GzBT95`FbIf;91E&)4 zZpqvrduzVNq~RK)JVRMsJ-?whJ$t-tdyr!2`xkQ;_etEa7U^n>*7?_C57K2}OLc!^ zZ4fXk_uHz&)j}29&(Uh^1ZFURu&lC~(*I{<s7`> z6(y*L>=*hhReC>X%eq~zj}yA;HvNkzxn>5h?Y(usyUk~*Ga7^(zu6g^nu<9%@WQ0M zWr6{2XvKH1#~^>Pt_f1}Y_Nls?Jkw}0SZk`J!TNg4vKYvd%mpAsrDvN@A1ynpZ}5p zf$^y=k+OooNJ}UxBCFhPu`nH``di6b_iiMaw2)pM)2^JdaDCr)qli|LJ8;k>F|S?_ zP5(;j8QflaaGs}au=L^#0(@^6M3aEQWp%0b>JX3f``Tj99MIO<7sw{_AFIM}BiTID zaftQv$O^dv5_5yLVXF;EK3DKf^4iT2>FVian4f!pAYFa?TxdN^;N!ll--(k2{mHSq zAF8*$VpEcWPTctBO0(116w zx-=U%KhX;_ez9j{{=6K{Zl8!->$ou{Wl_5##?CQQ)xi_fhf zwlCid>B&r#`WoU(uXRANlUDL76%K-zCnUyLb=~2)z|T*Pm~#LaUyf`8E4!YsI_#U=uqBtg}==XugC`v9;l)>>VNVEZY2{yf!o|msxIOpkUvG+p<_9v^3^?;C%AAR{KFw+2ZC+FhE5Q zQ?}`_jXrCEb`npEgqSMiL#@5JfobJxD44v2so>#^lYuEBUz{^-=45z!D*EUI&Z|AW zeAnULyOS=~PZpJ!dmp?Ivo%7^soNH9XSn>M^>U|j@D69hqOh6ENF+BYTSpTXkqS?L zS>QvNPIwcxZw@&=Miucg97BOhqz-lj-q6z;&uwC>yc=sdz z|HkYYk6P1#A?p5Pjk+}NEwDnfAzBd`5%g*~Gs9yo8);zPy2X#aMI#QkjptJzoo+7s z(S1$&n>^xH1N??k$BZb>34))C#`^ANOzr~S?XTal5Nd!H_upcL*IKOPm6zX%LA?N7 zOiSsRTyAx63{y{s_m{O$lBR;>@UeB1{{-T5QkG=MvZzff2^(Gtc+z@3?Y(>fb`m#r zs#wyC*BVRYau>`r<(u?wq~GCW zgWVClZ_Q+cDNJFHh>T*qg_&ziM#6Ph9Z#$%68vy0_IH%~EW5W^^Edj3_KD8{kOX>A z$jEwXU6T%$%X2#ZcjSXB{^11|L=rzmCO=wR+z9Kni=$f~{JLQ%iBWg5d#SBoar0#N zL&noGn~M%+9Ipr0p{BU-a7zv)l3j^4A^ucX`<~#pz#iSnw?W*?gY5&4tCi~LB>GR> zS1$YoDjqcNYJCP1uz2O-imDzFXvG&d_1i4+qPHuS_!yLWW>x!X#M{=m@Cl^A#e|3G z7ZKt2y!KCWMC=8c@DnHo7M2ZF%tm|Q41*Qc$J}dh&&ir1cEp7&Wln8n#C58OziERN zyCM~;qNdF*P^LWfF;o0_dPn0!2I$u5j&bo*rYn^rop3EdmaSYFnIp9HXzTE{O7cq$0Tq|B8u4o2}al7o^H$jUgO1#6)QP6Q3 zn}5(0ptlDqdyxGmR?DcDux9PLX!9X9GSF27^cKE4f}%aqC$H8uZ{xIcBtNyx=7hYd zPwi^7*o1YNCIFhQ_Jn+5cf3~NmM{8YF50>BY4V4KPgjNVx-?FtK zx}FlAFu#{1dg7m)C2<-CW_u75n0>i@mAwV4MDNbyp7#khW;;Ujm-!To%7sZ&H&_Dh z)V2~Ralc8(uby*5$yvVHq?rl851pb;=OXAURygjeci*vcX_+BOKM*TxKW6={6A2%- zQ;6Vy)(M+uK3J4u0I;B}_L2bASnqrY)S_#6+ zMltlWW4n6yGp#mXsT5d8UO|1BFLh(oL3DyNQ19!+~vkEkBw?5;9!_)@E}K(wgnP8=4jy8mFdEL!@lcLdi&dFmI-P(rIn@8t<XmIIF+cujbw@)pmF^a96{4akj(%$CqG9>jK$Edcq^D+!&B&>rcwo5o8RFP) zeo=1|Q+jHkQ{{rK_{p@&?=AB0(fWMnnu3-C5gdpA#!n9SaK%mfxg}Wm4=@pWS4RRy zd2Bi~;)R@e2|X3rbZabAi7d+#ZOykE5i%z1qz?ic-@mUxn*SgM?WQESBP8~)GP|hD zjPw#Fs)B*3K8IuGXyL8*+%bT*)dzCs^iWXl;k*aAg94hdte;-w$aEr6qb5(S!c%;a zL}@E%u*93|l9Ap}yhtZj4D>TM{(FF)(5Fm#GGT{W=na``<(!y6G#vlXa$Fx@x!^iX znk}p|GuzoX!%aQ?O+*0~7)RevC*Z$gQW!9d?JV9eB?4hR(glF6rOl>jNO;$8bX56l za*?L-Z3Y%{(i8otvVsgTTbrj>TS66X1lfEnwGsb(IIr}LuNhib{y8<$Yv^c7&kQYQ ze{Je~$Eb@n!p1aJc=`lK{n2CW9R1E+;_JpS!nB&v}Yxt zwGMT(!8mub)l7ceFgBQR;@!*R9#uLbKr8QEn%ycrsfa?s%X{p0$UdcZSxj1Tr~+0} znV|h!jf4Js&~d4jnDTxRl?MSUeKKkREZTW0S?^NIHvRQpNnKt36h2~hLK|)jDFMTI z!+HU327PJmXYIS>*)|_umI%7Ky6^1n)8*D`Ou9VXcTzwzu5-wyg<2^|OkyTqdZwrA zLN;J~b$DkrVs`qt9+0$Bo=+h@*~wDV7OW%J3PZvYn|e)S44Dc{DOBe&`o2wyb;aLR z$ypPODP4kb3XWNJTw+W9ctdCXFxEoJNF}`?*1Mh3YuUmAY{3?=;i7myOMzREXBxHx zLsKzKF)++59nmvOD_jeh(1?<;^sg~e>bs3hI%(7wTHemdCM^75au-nOhmO9819fef z&6yW@q2B`IxZ1k=(8abE-xzugB_qGve+2YD6Ev3_=N!Q7x!FoSA$Jb>#g*`jml*`R zo_@hUd)>{LmQPjjMRZpddedh}@(}2he)5whw-6S{0pq_n^Swvg5yDK65d9XTS7}z` zY*rrYWI(9z!H98scLOV3(Q&CM`{=nMzLE#_Z0^&(AD0Oky`++E+`SvBQt8-(?3^rM z%D=Nor(F7G>q+K~na`>fGbf8L>K}@V0n=FWy55XSmmaV;B8&4&+z zEG*~|C!NWtXl85t6^^!hdn`e^2rU6!+B9*F74!;Y4-mSCO_U0t2H zQhagh&{PBm#ni9<0}E9d6J%t+9aY>=jA>_9LV5tdgljZ#UYM4^-twxZqrt;iW(eGOv5?TA{%Gi){5FFc7~^jR0F!DKqL zGYlCio%U^aov9RVK6~=j(FKN#n^txqJ;n5G+=*#-u-#vPzRZ!{ zDicgwx~0pH`_6fb7I#Y(rQDCFI=)W3*) z1XQ-^4~H6KPpBDqS@|f!FOeJGHWQMYvK?tCRO0;bW*NXhn8T2t1vT3PyeF&@K@5ilQ~^hEy!Q3U7D5TC()b6|4{mo~L$<_+Q2 zYnb*|(TTyFR$gnwz-objda)K>pgbSCJKIrsgf!1Fb&{*{hKq8eA{)okPDF%JJO;SM zw9rpVWK+8<)aT#HF>@XRM(k$tB%)xX7>`~hJHti9-|t~TU{yfG*IH)V=1Vh!5?+f2 zxrYMofn05xWBt{wr^ldOUROD})oGdrSdPzITdVm)LDs(t1UCDCVp=X7`3o4Se7ym8 zZoVQZ9V10|8P3Tb>&b#8;TlIS@Az^pWU4CRpC(&%q#7E21Y)KAV~xm!A%s}+dx z5tI6-X@{`l#`N<*43vw~-LdaB!OK^PC#jboC~rs3P#}vEX$XTcQbpSSx#OsTt1-sx7|N_C5O3q% zFPn4*OQ+nUf@2;w0?U!`9JHbcr6F9{Xzf>^UStuq(^IE5BygL4t$=f{LLATPe5gZrAlIB=?Iae)2p`INLkFpH99=&{t#~o7l;Z9TA|+6=_&I*y+lXm($U@ zY%p#76Iv$vUpr79SsN+?B`1T9buH8c-M@~oBZkPA>(Xz~R3XD{le=U9bRXW!xoc~4 zE#P4Ce7fIoAYmI|!?WM5RRkHa4NSzI9p(Q{5fD3*dU`+v0Fv<`c)SYz4>rqwEE#-> z`w=-O1vmKDjVb?0R}E%snbrxV3yfZ%+B7goZd+7<$+LOo`D3URnPDr=e8`Z z_ZOwNcJgcqEGyj6dErq+_^@vRGO*s}Y95PVrSCsm9OU@cju%w?qcQiIZAh?_B;@z@ zU2Tjf7rqP+!Qlg48rR2f9H}@GD2w)kU{ak#RHZG+X@fIzI+#Exi z8;?M#;Hu6zAb@RN7WA_3-Lr4~o@KbfGOzJzQ(yiVF4l}84^Y`f`{ggp zNtu|5H;{pzH_2%>UWTVi;%PLB=4#0$6WSj+U)ey-jz~ZE-mS4d7{29uxNI1aM;ep1 z_5-`Jk{mpEe(-W;BLn<@>3>-suGQc&hI~++xSfePg$MYLm$XeYa}`njTdKVVaS=rW zl_%@)#eu06lF!Vm+F=xno;v;;6C0}UVU_#^I&SbFoak8Qa14Wa&;*zd8nJLs$X(>8 z6|oH|i@lnB`PAtn``twkZ_&VOW!X=2XTC*8hsAaY6#lS1e6zGezJ+>@NgdG5_K&$f zF!AcKrRv0pZO4#jv+OW}0x zbrT|7^ii>&1?fsO$Zgyb`WHPD`AzHr_%6Io!y+6lPcC21DlExJ9pYr*%H~LNGO!ST zh_}~Wm*mzYe8t+Koq@-S%xh~?uwi9~p#GZBpchBZP}3O>B6v#kPH7Maw?UEBS7;H} zwyXedfKQ;j097Meji!ie$qA?%vTuOl#o)XzAl#)kIrE`(2E7L%M z(H5xy>NSe5LoKFz4Uf--&P57#5oSCppE@tocKxEdr%;=j&~ux`0uEEBa?VF{YQ!=jb7h7wrsqNe3CJke4K;j#81nqYHs?dO@7pwneIR*67$=3Dl;rR4qqLe&ZLLk^~b8fI3`P>r0lnLsQ6kK!tKO{1U>$+BL>nffJ< zAo)6%_#*>a6HiyKaUEnEb&UKB<&%34<@;RXaX`aU6;jzugr+To+iS=*5VljPq)2N* z*NPhnPb1%ggVpTt#IN?+0(FxQsMIK!EI8X{=d@&{f@^S7`AWp*1GtVU7lQoP?Uf** z?Ed95@cIQo5=89Wyz65%Jz%&iBhZbnGXI#5Kb2cR@K%mzn3T?Z{-BC-@4PE5*@(MT zOagBovV5M^j+P9$-N%7$@hA63ai7Zb>YZvE%4E1da_Zfa}wh?)~V}os-1S?6(oO+M*T+|CXi{++#{F+g4zeycCqqkyD0< zk<+V&FJKr)o6M^j%w(SRgU3Ea%H@~3Mx5l6)6+K+$5a_nleD;^8>wtS04>|DX76aR zI;kkgC<1bl1A{vfHh>(+i-)5VATwZRrqh+fmB7#hdtqK8O6TW8y|K0L7*wHiv4Zw{ zj|&TRdtG}lF+C#WdJPA0H)77-I@}~0z+&lDL(4n!w!i6iYIjk??#Yc?;E^k zoXV0vkxt)!<~Q2|0qR%Oe!v___j`_+J+Xi=L|Dx^rpqwZ^QE-}n1ynfNp?aHEA zd;ML4_cNwZJ{Nw-Ns3gh^6#xhC30iS>|Eu$ubSoFZ8y{UJoAI>iG{`6TVTd<(%d<2 z+w#Pw9`~l(G@ticqYu$-*lq3}Yb^RHEIa{Hfg&p>nmyvH)eXeS*BO(Vks&V)%_ccC zo-h1>>)x9<+03`bl-AvMYE1f+^A(z(y;r(c`rHYC?b$Q^oLt;rb1)ryD?3_st*j$Izlj(`Xf7((RAVi^smcfPBhJ{JEMtn1Xx^& zJfZu5V{i9G;@WP{eX#!N?hkiutxxiH+_AoAGV@K4j+hUbyU=XPr_sKx^U{S~2`{8G zU`|1LMi=ho4yP+LSqhS%l#d^&%`_vvq0OsL1P;T;76eM_u+T&f1+#3uEOW)8LqYFu zl~rUAp)5f%1Y(Zjo@Q$Ie4I$D`!a4kO#SEjzV?HE<$+`DMHknvi43rptbKVPvh%z5 zC5Z@woXb2m@@Yy1ua8Or$wc_QiwWek&sdxlfRg2Xla_`m7Gn;uXA zM+rEXP z=O{B4PlRk1>wtTBlSectGmamJ)zyXwEMhB*370iqlQ5S^val2L6Raq<#uNQ(3DOIG z;YBIk9o89sW)Tm&yiEP9!pOV(h(4JZZv$HfmyLz16q@X4n_J>%O{~``?w*7u!xilz zuNS*l4u1MImd{BW>)hFT#v?ExiNbUWSn2K*F$_bm+ml3Jgp!(KO5<#BTZsNy5bwRz z-!(~cRWgdFHjm)PIq+^(WmswU-e#O)`u7WW^KC6iLqPF;v!(bE3@gASh3g=o(Gn}* zr@7fZ;&hYHqtaFRLEfwbG!M;R!}vqBz`U~fffxP2jIr=-X-sE)m&hFplNOahSvRt;n~wogvptinw+riqTJqW)ua+VONzQG=)cFn= z?9C4*M#NqnN{iGAC}?}-##_SK{-v`vmLtuS`KN$#SNHr{)ZdPt!nP;#l9I*eaCsSS za!QDKV~xLlAGCG85;x0~xh`GWT8yXhp&7qof{hz52ue>ore}Dk$16xq-(%4?RA*oN zYC%-#8AXp+3Ep$JFD5n{&jlLJqp7_Ii4cb@&sl z=K(lX?>`tpiE1)JP%)q&rBPA;o7E34n3&~RlSmSs=&$1vG3V{&)HZIH?)H=OZf~yN z1AylMWqhzs^y&kPLZ2CPOA>n$=W57%}(3lf-GgnkGx#)FuQnIKhQ z1p>L@O;mz|G^CB3ylz8!Q*djCvo!a$R`jis`02_ADA&;*D8Qq;^XVf{&QYSZh`ve z7Pfi$y7G{1*BuF2+4?5d%IBk_Itc9{b^)IcggX$eX%+rN=(fypahXpCdymzFy@#KI zJ@Vu@`d3kB@8E>ZW5~$myzyvr-t3Z+wsiYYPU*5dM@Eqt8JhvS{dxpR@0iY5Y2-rkKw(02TXugbD9AKeUk9JG2ir+vl)_3#` zTqxoS0FN`ycg0q5f`2`Wt3w2eignoxAYtphG#qqsskZFdi}^*4w+K#!>PRYV2$ zfBE7CpslrD5OktYF*4XOt*R1tk`%7PKVka**^vSB>rQ02UP6K30g(uP;5M{Wk0FxP zD`2aU*zr+^O_d^?_5_%X-@VufxRM}?-W_Fjoom%}ErIS~;zjRKFhG@+?vwp6H0X?< zRW$KlE#Bk0>_0=i%@5?S^bHQ@!;nt(-3M3f0XGR^OGov%+nZcuxXLpGUxd~l4TbN9 zQd0Xxv;)!VLqA0{+u~>#CAG1gX6?eg4Mv{pC-eD-h6pqZSMk(cTLK8|nwH#N;W0zX zdCG`3KY83wjey)d=7^mdgJ_dwrzLQjXEvSfpZ|9KqblhfT0IvYv8kyh*C9N~`i%GW zjH_RsRZM6ON|WNDK0Vo!8__Mz3}sXa5r1e_;2J*ynUyn5!ZyyadVz1Sl3+*=5Go|T z8YKd22S_igz;+s>3?&CaE2JtL{&3p){uRUtbvA8+-e6j-PkMx?STS<|PyLIng zgd0P#=N=0lE5&{*TMi2 zj9L;2&bo`2|wR*UUdSbmH6#>*(wp&x<=9fG;KKwN(A!2^|0pz=7eg znBUu6ul!#1F<>7lQeP8w@9*iH$JU5{sd25ZOU!|=- zTitWw%$up|{pueFYU^sZyPUR~ZFR<&tL;;14tr~uuC2PeOR}U@vU+G0Oj-nU^PTV9 zJJw}1Kk*Emc;BL;vp0TeK+H`$y>kek-prQvZg5VP_EJ`j-cLcDo|iQ4GZ4nIdY z{<_tP`k?4&Q@7})GA?Jq-R{0VAB39M+pBIW)f)o058|ByS~cN_`_J<2KFCz^hv(EN zoPFCZD+HYK^5rR)z14b@2e>{Ei$0Qddg3EluzcdJF_5f&LQs%G)LDSl1vYM*#ib4r z@TaiH?v0;^_|00CO%2qm7&LF_xGeQjEpQ(!e-7PcDo!{nFT2KSN)#lU5#3B%{mk(7mBdfzmT^uZ&@THIah>&m$ zTFA>Fr@jb~Y%Md_AXXhbAHLi3;GUs^RZ$IpMIOSj5xnDw%i4=tS9nwlz1Juvv?yOE z!KdK$K#YCh887;p9EJ74y;}f)TpAjt?48o(rEYT!PmdZQY(s7850z)U6h6GRANfD8 zl*VCv8_Y(PJbEX4VP}B_W=IfNreL_B;=0;1R4gUWl?2kr1>Q{T-|MhdLt-7}rzoEycNB??#Bgr1` ze}!MA7@p%R$wPw&Uw1L{3`x_TE`PZBM!si!A%x&1re0@6MetZqfr`>_a|8I7UE}k@ zKeyYqAVy+nW@6Z`R}%qw?hIa|sV#=i8vq{t_9hI2+~1QxRP~#v2P#pH$)ReN(#X~J zaS3@?5X1rfd`Lu!d+0c<8UDNu{x?l1U`^(|=z~=}+b*IJ!bJ!*i#?rdG_!J4rcH9_ zlfw=0Y58U7H-niBbJp2$SVvVC!oaSGD&T?+wy20##>%z|bQz+-9xxr^RqJ6W;d_+N zn4SEuN(^|IGg|v;l2g*q$Y(I$rrKudiVBYoC*&i_>w2@QBu@v%?4xaaPH$!}^>=^i z;A5CdiJo%)X9EvHsA6}E)j~dpBVm2*l#E_L`2m+&eDC~C9(}oz{ZB-wkMzzm3At6P zXm+e%!tiDG-yBZJ%taE0VymVc%k|*oMqd&A<_LCoNd90WGkw*XSOK+=7o+dkZ2P&D zx&nocmK;gnrpNJ!vj+o`MKrByq8$g`I;8clvso$g@SH5;*=# z*75r+#@K9W($uy?+qBf4)t+&d9y-b(NH~JHr%yb%clOxEz@-l152`wl!4_DVSlNz0qFYLOY?9PMjFbKOL`(ql))r9{ArO znfe}4tLU^W#belRzB@O#@-mot=aj)kK#3SXiVa%0s2{3Q#d{ zXV(%DN6<-kKh{au~mSgat8|M=$vr9ke6 z-{BZWu%-=%hWXUz%46u|Mux^ZW)$ZB-5vU!gqHX|UG&>Sc!nM{s&U^$jdMUGsV{gy zp~F9D$AcR%9bWj7 z!SOxD#nO*;4j*Ebo1BoySTx0c=VmL$6rR-ozHSea>h(1#gJl)ddnBZ#Cs>X>(T5x^ z-~ia>Vpy17v1`(MZ6F1aBb>(it_y7c^S1u`+o8J(nT|}yQ&8}W0mp1HbE2E8aC3JR za@Z7y#sB=o9VVvPW~y*}HSvVKI*9ztlj%o-$`-=I%k_}|2n1*O!?fXl-g)2A*P}^AFgSKS$VN5ZjTEkPyLbMvl;3{cWgRzso~YV3if};kq<0 zkbgjYDEx-f<=YeN5GA@>B)$w->LZ-dpQH|-K)3t=_VizbWUv16Hn5I*!*7~^Zdd&h zy3`7KWO_gi@5?g`taSu`xA=i28Vu0a(3EekFMe)TMKr)*PjLBA`d&LwKbCPSB{dMp zEyx$4#KjT}^dA_*@Y5|;*8$o3*lzv{u#oWp+rSbk`vNKmjEy>Vg> zQjOcTC6O`{86Ca>){Sy;f#=g;lRsbbo37!1B>2WS;X?U&SO@t}hzC$qL0%G)6L`+N z2m^NFmWEx8c<_tCB)v7Q^m5*M;xr6GC%9U+tlghA1tw1Z$DJk5k%Xkt{I~ITwq0*; zf7xAJQSnS>`G(qB4pda*Ej%MNKtPex(h7j!hl#zlHgO==-nen&Jyjxbo`A+Mopp|! z9EAeoFZ|=dZUpBj6_dvULuLvE8>7kWnKU;Jw@o|+-HZO}L zVYhL<(z!)SQgli{06xS-Qh?7{F72*XM@rQX{_S*+TE+3z&M-potCQK(i>nha*u0f( zF{4DG++SEFzY5l(hiVA?oUJj5u5IB05_W*~4*@+w6?kti_gci?-amws zFDWTW638C0+dX*TFFOpx2-ZJ~6yny_x!YC{BC*47o-QlcmLo3jsQ|WMdU|ZxYpX|5 z=fRl`SWyQsw^EXassUImj8!`TmdAz5mp{8eAPy_fPj>@@OUW`Zeovnsbpd}f;(UKk zH3Jn^&9|whjDY3-JZw=fTnrR=k7(%VjwK}}rDkSw$DM(G4pa(AOc(69rzaX48kC3=5m)nrQ2<&V4W_V}BZ#w`l z?~+Wk53ro$-@dJJ(fDUqML={D`lt0Ec{{J58~C*d7?WMc@fX7{ueBuVgL!r@s`O z*hk1H4qGjdyLIf?FD> zdFV&8^MF6|SLn$9U1Q)MfAx2J1>hvek8f;bC-B1GfSx3TlF0mW2bavqBz8F5JX}@D zxl+glwjxp|;!-sJr}OgSg$oJ2yU^rtMm}8*ggba+y?y=qwVZ~=bA)!nZ9#DSxQK{| zM-O6Oe^K{M-N4DpdG3dQ?8SO#q0B1~0hH@Fq;)PvaOta1;tltEUq z7n_e_YXF_ZtAKv~LA8nCRmD#CJq4V{ZpO9W)0_vLr(11Zvdd*$DGlR75ALG5#iA4> za^>&Dkhjr7kwR-_X|moTAkXJKibj`FJ^CqDiB%B31mwDhYjeBUp{iMg_zum7k0 zqTde7)b#Xth^$Z*;+J^-92Wt#9|WxebULDqk(ITuk8c^M_RpYliLoE{h0gw3zc0pqMKjo(wzQ8Yh zY?5f8eE~ImgBeaN<6%K5rn`a@D$hm$s0&^EPT;oWu1~_hnEx3 zUGJTe8Ow}5#vG^ z87Igk?03aZcJv=m(O@BM4m#F<4W<7&UMN9m!iRVTPd|3M{0r_`9&4gik@E3(9fh0? z-v+ud(LF0onQO@IcU-HDt1VPP=O4w0&s#E>(Ln^2T>7iR8h_K>xU~=%ODzXRSN-T( zf7CYrjxnjMH|$T9wk61dM1yI8xNtp~w&TtP>{@T^iO?CiwJi+rR>1_ahevKhF-{}q2#P>p)gf>WhzmfW z%=jm~bK=whdgp8Ut8iyL4*i@4GYAeSvQh)FW@if z>14X|4YDuxQ_ihacaVd2kdEX~DMLeJi9}RDE$Bx*nnpq8F>`w#o!2tAKki#5`p=?aOj`yDt5O&PIJAM9p>R5XAseX5`H%Ad{+Vm_KY4Y+4qRH~^dCMr79qV~mz{yHJuohRc=B5^eXUlm^3v%KK@n6Q-fenfr!L&4gXNmZaQqBR#phf(z;>a z{#0Y}HtMi}Y)r0-oSYmAG$hHbya5Com(!Cm<4E|Y!uLRg0}an~*8E-)|NE>p z=b>Yy$Qclkcw`=q0);y}9iz+ns9(=ooKMirvHpdUM(J>|=_Afm+f=0uFC+mMz8VG* zVIVvKpa_GmpWGN80`dVIVvP}V_$)A>5v3yh5sq;r-Jjk?)#yzM=y&*Nz&IJy_lWfd zs0QH+R$hpl7H-bX@g--@*@iLU%vZMHzz_nAF+i#t#FgGqxkTC@$un}eywo$G^L>#w=|Y&jPpuQ zzXF7~k5I2HC`@v{`NIM1>iz2{+>!#g=iyg%8YA8BABUfk9Qymu|M%DY>l=~+sK^+R zkB9p?CgNuQ84d>fafZs)*SYio@k5%Cwe9XFwnLg48qUMmzMAbgE-q&&Me!Z@bXZd| z&B3o+UiWo!RGV28 zKa))@ZK8*n`L-1Wtj3SRNHhh62axp@0eywwu&`S&{oID6X3#8fmWnZY!p}vnJD=+g zC!`i7!!f`VG#KLGMkgjj3(e76K#;!k=utsGoz&U4aFIbs;Tsq@0~MeFprjxP!xLab zrzt7#0C60?xmGtvC$GPmMd|aYsilGL&|u*V5FTAtdWV1^0F!~ISzNw> ztx?U`D@W3aN|s6piDNCCY*`u^$w67OXQyNNT~9OfdFTD_{p;6%W6n9>@3Y& zM*ciG;OPNb!+Sh0(O&-1smDJ-V3m?R;k`~TgNUt-jbUOwp~FZ;Rn^%~#aCGlyeohB z;r^lDRzVg5LO|y&uIllrsjJgQ+SR&-ekN-ZnxDVVPM$Fra62hU?Ck3hQcp39?j4Jz z{B$#$?54kd)hqCFJ$6sU-l{@x*_y7D&uvmtQmAhTLN$Q6JFRLK!iEq*YgRF!GZ+k- z*eWO_n#X$eNnjcMt3;+zs-cM*3(^CU;^gX@b&nT)MZJxw;#w6%35@itqx#LsH8nMz zmgGx3elL|>vBMPsC_0S4Gyawf~j+0~U*R#v7mV0^z!eHeNG!e*fxs`#f* zp9sHH8AH#B5Ig>pu<)Dv2LeEW@_?Y)qog#3Mv~|VS(9N|MOR{OgSO=n964titsT2+ zvJ2nl7LpGEb+yy!L@C05Ebw=RvU3NsDkv?|3oyBoGfOiC&YecK?5dm6Ie`pJ3V8K)*bEb{JU*dLpzFSfB8eSC!%^?zMPvo9u;mN8t9OlPscGvzT%C_cM?}gYX~w3 z*p4sb32BuzRAPq6ryPRIFOT zNSsPBio}>QGBT#oYV>`dqgtL5XJfgON8T7muw(?N8Y{?2M+|GHJ;=BwKvJGtuV%_`VKni z6@!B(?_Eu108w~gP*9w8Z7d;nd(b%OEJRuMC@PLXjkTk%Zv`CAjH&P}!{&{&y z4>iKOQ8FW+=Pi+dYC2L#m28mqLYh-WoiA3MAK{_&y?cBJdk>OjBDZ&+zey9@*51wv z#tNXPDu1r~umjb1{PPJ|*5zDWnbxv$a*^;;Ct&)9a{Hy87^FGqH|YhR8?i=7?88#?h9RZZi_ZM%}7Y1Tds$P2TpWvQ>Iu~ zWn>4;taWR?Xa011@N@g-TgXo=*45QLQxvJz8NQd+`2%0@RkH%Grl^Leh7l{){(PNI z|IWnMJ2^W$8*g1{k^XUTuo~Wz&_m#iASe+6*X4q~VW`Hb_-hKCdus3XU=wtrgqT}+ z&viE2ge*vyh-wWeR7}863$s0{=l^^vfUb^+Y1W|D_f*(j!En^ z1*ki!t-TdGO{gQi*O{ReB^4s9c$4f;9L=@OubT|#PBEQB1?AeIlJvm2<27ZHx<*As zWil`+<yaT%&etEDYFBtA3Gw99$zGT;$ zFJNtLjqXrKe_OR4vRUGI_m5~M3?m^j-Ii}@u$L!j_D8f^wrk0aBt{s@XENA(C;)tg zk|RU(@kWI&8l9%TXP>ByVM`uAemvG^(vWx!^lS64;>nN@7vH#b>lKuH#lqCW&|j{$ z+Ql@I;9|4cpWi*^1t%{3B3~~-b8_HS*O>9!VWSz5mXX}h#0Xk{DOEHdu zD)8cks=FCt3btQ9zCw+CB;saNFL=W6ctTTnWPE%pb|UOp=Gn4U`VCeM zGI&Kr_o2H!3;^2t7xu<~)Yng}{*7AKnAWZv7#IjWAfjecm*aePsA$0#6a5;hj=c@Z z>)>y(QVqV;K_~}3(tWVFwY62$Kq{dr%?0eL(w*JsM;Q~oGdhD<<7ipSpu+0wLX(%6 zW22+(V5s8^(#*Ue5;wqRM&LHVg~rrs^m%H^u;dyV8tUHQPd6&6fzxi$K!3GpIa@y9 zDoK-^>ky6(fu+(*w@{<(+qdr#wWzQHwsEqb4Jn!*1qCb7sF}jQ)8fipzWzm9uKi9< z&*pCN-B9g=lyf(ccx`BiM2%uQc*OZ?PSALD!e{z!0=xecnfWY|Yw*fe2g$whS zX6NPxS4!f$jm$hq2=c4??t@(A^z`)mT4%oCr3j0Fg~`a~s>-M}(%bHQHWB^|z)SoM zS_XdX?>>A5rC%dJEB>5P+_PzI;r%E@$uwZE?9k;@u?9aN;kh3t)sVFc1 zh#7=p=M}gJpcWQj@5q-g6shB@#b{enBlFOv@DEtH57~}9CN*~=B6#r*oA>N_Us{>4 zJ5PTIw=XJ?BCEnd(YI65v5`{fH)=92@RCD6^?l=Yhe9?e-+>)#9~jU!H-F%;E>g%X zh3!M)EXUTn2z)Xx_Uc_*wLS=54rTE~G|@PpegV!1_@+Wd!we7(=bhL&1SQ>XqDzpn z+7ES37#F~gXp?mM(nd4{WV!@~g^8kFG=K{Bc`;5o6s%>LqpH#^`8%@jn)74&uHU?Q zP*Zb-ljl$nESA&fx=p}QB`{8>(=D$0FqDRJ0uWC<-n30&z>5|I-j+10+o3{^ z1OAdI=fJ*AejP&Al&ISCYCKwZAgk-^>swk@#xRVdA84$MNlQypb_eXU#Cl&iVj56* zE7CaeFF+v4$A!81h8olS=C-%_a(3Wmf|zvCtSssA3pDnsq$B{f%Mr1$VSp#1d2}JS zhs?2wi3F^uRg`oBz2-lB3<`_~c@joOM;8-m_tMhRx=iciB=?7aBTCA&7)Kb_8^9rG zry6PIF{)z_!Wkw+34Tr4m|cp8cp}@b=-Nm3F@&uEE76HdwrF`21^17;L5>vC#4xgWBDT;kmZKTIawU#l#7y3UB3}fkXj%n&TI7s2vN10Wo zbFK1}jNN+~L=7xBj7I?KPM-6Za zL&&C!iHrY^iD-^$1FYSB;oa{BW}d7>R~QT-glXU?>OwLS=qHDSwFUvy z5zYYsb@ca>2_P|ove!7}8TI)Z)2C2XCe!-NZ^8G4L(7xkwM=s`T?d%Fnc|nekywDd zFK5Pj2uDJZXTTz9!a?A5C{hZCR+ij{{nKX1r@Z&ttZ(v_&vxVl@n-Fs1-xQ(6vg8IMyRDjU?e!43 zTH~SvFe)`dOA92FgK|ruShmTDQk+`*<`>&GZMs~mx?nQKRlWo4(0|y_(zij~1JMwi z1sM|O(2|?~rI?Fg9h}%`(^&e6%9fObTd`~!q7aNu{)O|Fwj|DK_+= z;9xE;KFOC=Rl(r)FuH6y&E59=1rO)jxU>g5OM=9vgmU}COu}*gL(V=_)6iJ*%%$fT zC^el_b%%9$>I3)+^YPt_|C{*b-8K95{PoRXMI-mgCH%u&mqPL&_J1N;|5s*~9go=( z4rUbtqdT~L%Pu8c`^FQ~j13`s&lk*^Cxj`~XFIU3aXW%FFshvnFM|0V>!~ej@5ccF zuy*?Ra?$q&qIj-lbY|01@{+d+UHINpc0Td8lDib)7Hjv7h4>hvcnH8F4kiK;EhD!Y&+sopz>+=dgCFXwJ)k2&at!wo zm{1UhuQT@TEdLQq->)Dj9UL5Brp(+s`UpuXDtZmkWBaF12cW?W&!my=O0gY!bz~`Q8FAbc9=E;lUG4L92 z+UOI}Lw?%VR|WCceKe4VIsFMB5LOL@r1Xn4I855Y+*HT#a5!8B;NCfC6B&5dLZ0|G z{%f_MU{GEj=NHFKNL<~>(8wMpjJtoq^3K6Qd#W3}E~5L#`YD2#WMbh#6uo_XQjA1# zKq6iZbMOp-*s+9_6V<-$-*6#I!Iq#&gvb;^sNqs^JZOniX=X9_iJk64Cg3?q6b|Z- zf|-Ro? ze@RqSbQA?LyKL$<5+IEqPva~^W9W1TKA^J9U~-MZnT|{WaWyIsQXzpnD|p=u>eTQ$ z+qQ2H9xmjBA%I^}hxiE1+29IzQd3i3b{W6HJ|@&C#=TTZ)d!y&I*Y&u^%>^;%O?68 z#bjizW8;{opQa!ku?24la_pINhdM{r-F?bJ&KKm-bGxRSu(Q8`rC3rIf0P$&N)5ub zR4=&P$5T;8&uv}-r2y=1 zR8eVF>7Bt=J%XbMh?p^~ghwJ@BjS$>RLxT(Rc9;TyxEGsA^ad6h9jb*4F~23D|rnm zrE+`CZ~M92z85!jAA%pkU4_xfX2(p|etpj8&Hh-KRV6Y+9t9%jdF?7#MeOwtjlYM82pU{-T818^1|$q;(%5)u-#wACDGp*|R zkz-59Z3-%RSz)~hJrD&AKjBDaAjrodd5P1WgS>=eSe^wdX!4$I!xPtPFU)+ro!-g6 z?9>jU=g$;OF;V#Icc8|$?%a6;{9&_(EI5q5CtEzh%(<|-)SBnP^v5A|F)&H;o*AXg zLW0i{d4mxCoxg%OAb~Y3EnMZZ;qN!f%HD*rn;%}74~J$=@@4d;&&k0N$y0q^gaCTUM`RtV?W3fr$Jz>gJRwCn zP$gxSUk+5`mzfIdiKF-sYzra)$0~E*{g<2%7jz^k%UB9ici?n?S=?jAlUiT zC@V-%?!x=1h0#eBVv_6be#=u*aN6F+sd1V4&RF92f5#PW+-V{S2)K$lt2tz?%v`D1 zMM=P&1fATyd$+CSPsG|(Rd>)@ib&1z8Q+SHH5=%`%;QVz5xp;Rz%-EqfZWJwC=NNA zRp9_DC^Y)+d+F$K$OOx(Q&2?Ah_c|fIT@vbWhEIo!n`0rC&W2kk^oD7nKKkj51|9W z!aF1M#hpbb)*R4rtM`}=Vz}c@PBLUVjIu7^0`oJ^F{}Li{L>gW1w?=hW?2fC)#H&` zK-21AqN_%wwpnoO-ap%fp(11x2DF=;^q*4}Z1ebe3t{(ycXpPNL@Z3~avq+ZdJLyJUl(xQ8lS|C$Q!e>-h@>~8-!wHGzRR8>`x;Cjq> zascP6k}r6qf292%%(FTBb~l~$)cW@Cx0ByaBtCZdu<)_JoId#<&U^litKR*;eu3kc Yee!$t_Pi&d6#P4?cIk$4oP`dbAF>kX3$=v?o{6F+B|S7m_mtt}fdOa#Dx-GH|Mm+6 z8vOn9t0{il;Ts};+u^qzev`s?cKjU-zk^{m7}iaZ!zG3wP;a0AF;KHctS4ZWik+No z4{{V;x3Thp1kSBDmNSYqOOpeECi7AiK&l_Aw^4bl=vo&I z2!T8s)d>Ec7~te!-s*+h=dbh6m;>D7?!sQ_ZFk^qX=PRW|B(B$`zbJF$$*>@q<Q;pm-ees zA2!x?RTxY#G*Wc?SbT#r7cOSp1mvRpjUYQVXH_YesqHT19F^8lwv8iZB;bpm{PE2N z$=j(NU~xgWmeR2Sr6|MmPBKb0hJyliLS6bcWr7a+o~i_|`c&##;)@6sv`ffnRzhus z((DsTQt3Oj5w%%_u&GoG)puezsm#3cL)~1zuo}IU37;xL=I*1XB{54am)S(kSI0>* zs`Tncd#aZ(k)dt#mE(?#dli(UkwHnV1r?$xhK3>LIH*PAZ~k$$DRV5>{}2xk**b6= zx>lv>N;EeTnvNpTgUaX9H_Q8B$1R?bUg*VK{_tU%rb}&f4(U?$QZJpaEP-ivQ$#PF zm=~5c8pTi^UY!%9io137-kfC=J2{P2CgTr3J2EtEJ3_W8`8d&Y7w0=t9hZJSF(8*W zHcc(V$=Zn(GicU0otk?6;xf8$^@nMDnMix)LH(8J>Cqlb(=&AEwHKH11Jn-q4*ms7 zv;JYG!y$c}$xo{dS5zgpsq3C|fceBrOkYS%uCuu>+h?R4NMbE0<(64xd-av*>MjDE zO1KORU|?EW>vkPJY8Q6?&6Q}XZdJY2QeV|!j!*NZysJj%)oYq_=Ij2)EK+^1xP2Lp z^5to2&gBJoCQzqNI8^*O#)!F?@2j^eNo}E@CJ%Im?2^B#LRu}ZK)o^glRHv~AE4`$ z211exwMuI@3$Rhk?n!X>Zu`8dkrXy9IK{D!X9re`2O4#v0d8gck4LeaR zm-oY@`;-V(^JI_d-jgnL_ki?T$GgAq&8rl;@l z&e0v5VL4kALWjGx#4P|;d%qU6LwG>no_mQdu6YpwQ28G1lUC2`& z6g5o0auLH|c+nB&%&M;z>cA9AN^)Nu>OiTje*&*lrRYM!z?{U~#`hj|Ddz4U5BF$> z^R0{On7C5QM0T-~&+WpF4&=jU$;7&@9QJjCR-Vd{W@4)J0XxZIre`C)EYvXYMPQnG z8f5%^E*JgfWlCHr61_$320TH0U*L4GY-R{qu12Y5VGtkuQ86*YY5nh;Zh7Ez&<|O# z7G`&nLh>+mhD+^{iNa+fvc=3~f8laJ^B;I998=hi52NpW&9dJ{Q&_C`Dvs<(10O*2 zoL}{7uZY^-M=4z#;p;ZI9lUUc6x1UaXts~qL{Oua^4f|oJY^>fA1JUn~Gl^6o{m_RAV&M0h;-5ql|v7MdcP<4k)^LOcN7&P{*anI;s zXTs6%IK}rTO6dt}EeD*0_c}Z%(xi;)nNRhw45@)lb5bkM0O=glSWDvWA$!DZ8&u#y z>#Vpj+zz30mq{8^P{3idv@o3|&a8}L&pe-1L=SFKG!j`qLP15}Um3MkSTy8$>FB}0 zQBJYN`3&QXT+V~0E6e}-L1~+~7Te?JN>2{FWzFv=bz8{^?1z}%xC35LBj$Unk9(Ci zcXyT0Q?+XQI%8t?n^~wyu(Vp&Rk5X6Ow)(&NSy&(m9l{=(Pe71s&jRa`>VsdV3T)a z!&S1&YqwY|kC!ZE9_s2TSSc|zIa4Vx`$M%3eV4UUv=GlmdJT-WaNX6aGj6;0dYJ2% za?q=98#L?@FCP;qPZ;BG_dG@nba*f=6BBtzT8r#n$0(-xN^5#CM{FfVC8X$Quu&Z) zDi5h!(`QZd=s+OY60l28S&47K^w8XeVha6X`TI}}+rZ@k^q!}q&iMr*lCGmU*%z`_ zY}D;tpq4Sw<1C?6_q%uH%KxQe%yNCT;B8!@(c$ftca+!MVH;*-gx)l4zziV{^c?oh zh+u%VZ*n5*vlk_w6^rA#{Xer5j){tNQUV^C!agBY_=~2P7FM*V9VHc;A6u(2=N&C# z8}qj84|FQ+-KemzwYFnI#rD`}>gSjGwt!Vaz47(#3mwlfF_~?RQEmV$%?2gJhK1ETP#aGWqF$9&6TW zEm@}QZ{_IueoSnQo_C|WM7v~Y_qi}sMh*tb^|v$B%~yG`mC7a8D>yjyNhldHM^dS_9M%^sl}${_s#eife3D0yV!Rc?*Wsv3l>k zxtLa2R~tO7oPp!1FBEhK7CETAwY_5|P;h<(_sdUHx!J!)Qk<~1v+w+AeHHUcnI@s}J7mZD=;GTtJ%Rfs|%aIfmdt{6vI@dI|oRd=OJ3MvsXvfA3-`0lU z0+|n!(%7Zl*Uj$mXv#^}a0p+wWvcE&sQJQGCGHzAP-o3i9+JE(oyKMcM3r4|`*Jxx zuJvMFmj|;y9UB{sxyQMhj&;xE2JY2u-S~bicx(WvEksks`nv-$hD_Y_9Sg~)7igvP zRaim279oU#hA%a6i>pD0OS(kiQ|}2CagzBiy8qaCg?p=T0R>E9$rre0EFHpYUM$v( zGofH5g_+4dBd^8jOMAGZd{%#Fo*F?bnkR;nLsWV0e78H=(A9&X>+55qlv?y*D!jWT z{QGO8x-sS)R0hg+LqHb?)47qF%QYd;FNl-j5y;?sW_MVM)H7r9!Up;~7eEDtZe-il z=zT6sn>rh%gTCarnOdK`2bx%Gjb3-7yVxI_ST8&`?R&P;UN~|o^mdwQ%zl?ogxL2- znUve1&QaZKYfZ*Ii*hmfb$t2OKHI4wVyUkQ4uWplGcd}(;b7H;+9;7uS#vHuHeCVd zn?#KTGfc*qBo<1IgzX9*RaeWN6qVU(L3Co=&Cc8wjHQ%abMPr}xmTdwGdY{km3*q4 znu+1lT;7Avv9ih7Omr{y?mw}=O9|ETxCJmA{OoSB&R+ovhxEMelks`oC7~bQl{Cvfg?pNrCkOcVW9{l{jTl2%bSmwb z;iLGqXD-#Ek%e0jds=-{;k_Ha#`K$y%lf(uR6lB+Q1wumtGknP`+~6qTT+WfyKqKJ zq<6?48UUY7gG&r^OG6t=wDlXjG@RAowIsMvJo({PH5ne3l5Jl5gm$-8sM9eth$>bR zUh_?RWV(<^4htYYD@`jIExuHHw&hCn*i@a`qI!RB%^xXLEDf{3G0+*^q^@0p%;_Q| z^5kWoy+EWwIeWiK_8E2Q2n2 z_fqz^xRtQSU9@~*9N%9vSRzFA_`JMhPENVlQBp?I@(hRqk2T4h)x?uISdKb+k4>Ns zniSM%Ui+Aq#q7HkHx|@mlE}oweo0c~`N}G6>;f)Xn=ECNPUs=W zG}Tz%h;7JHyv6+!}gaG%ii^_j6 zE6f(Qk$kV5%dW<-_(}dMrYfso7<4k`txdk1nRiUO!XGNW4FUgLQ1sw zx;*KjA~>fI-%ORVbv;VoI`8Dtaolk{R#L<<8c_HmoORf-`S)3haw_)C>oU6n=lXsRH_}V@;YmbYE!TW;Dvas wgONUYvw)n4l5Cd9*S> z_y3Z$N2I`xR;{uX%?6W6=|PxxKzvUpnOWha2d^fEw1rhGqo3l=3wh3_6 zoy>LR*rS9U2zT<}o|t^WDB$Dads3rblb?K?rNFxq;j>Xmqs;O_BjQ;wx^5Qk`09B! zVQ)-eJ$dn6Lp=2qtNxCmR%T?65Q1>TSTn_DsxKG(5FV*2b?GSEiH`M?QS=;4`$b{|V$4HSz^mdV zruv$(p>kLtk8Un3T~K=DRB!OtG+O_6APB!xqd+fqa266g|Bjo*_s^E(#F1MrIcUl`RFywLWEnP z5oOqmDaEStF;&Ji4zGujLdsIT;hT0AdC^j2#th?N!nqH0LRqGP@q{epF6&5wsiSU# zgG_ovv}b$49SxCOS=f*Ds)_jhVw-K;IlS>OQE8c%a&JlX>Q%4#0gsk)ocAq9vnr;A zYT~B{2J?&GbWN++Y4R_vMNoaMCco2Y#h}#ckf3wI&egC{St0l=@U-lybtTKf$=JX2w!Y%yHPfi1lL878(&_yh20VBzSv$STIv#QKMJK z@+!Zx<;0fuIeyudCf#MJoQXo})p?@aXE+^0NhsTZwCtQb8g@ zM(z-C17aJE{zP(lR#H*ez)k!Md}0^hAk}>7hf>t$>_cJB{^!j!h2^wecwq+36At0r z73n#JzOp)3C(s)i+~#I?+#(^W8!=>2wHjO;>#mGZIeQPmSAk}kinzswa|8KnKc@BH zS?gXEK&hUo;yNQFqQ)E1N(R-KT#j!ap?`vcrHAi<;d15TWJ^USjw7cbEt1d zSZVz|IN0Uj7+QEGdMNx-w=c(Oi24`Un2NPs(ZI|?5 zQbc72y&HgPrtfs_hH$CZv}FCdT0a!DX^aWoVl~#BOVe;nwDdpLWE_x<#mvF)0VK)h zardD#Q_m5SPBI&HzTT04&@7P7F$astL%T(3#T>Y{@Do0;Jg@{Q?nxjf;-^04QGG46 ztNQL{H8TeY&dZq?)_Wc|Y%w8J_`xu0S6}j89!rTjBOp>8b5^nHRxLH>u`bj9sVFDl zwZh!e(F?y1*xCpPQRbntAIv6}sb#6%WdPl99%sd9^v=pEBtQ9$) zm+>@^0HckjE!OQ7#4mhV;*c{jTi_jUQ|tIz;O$OkZH5k592j%IxAw)DvLaABm+lia z#Z$nnmvLR&ls%a4)?m-!x8+``djyPa$>rBl^dVK4z|fxe{^7`i!6 zD0BstGqs*H7W{!h&ICvO;ji3u3%f@7o`$T2nvv4KT`suO9SVN*S@N(H*L z1scihFBWP6tC%t6;}OVNi$KD80-07gv7@ERXu*MjD9$-iP`@ELS0#+cz27jP-m(UA38_vJL)|#O)#Jm7%)V+$nfdqn<&f;H}Hd1zD;|;5>bjlFcV}Q|F@L!i+xae3wr3#O?Wpf zW!LJ^T*-$e(W0AS8e8%tD@0)#H8wZh6Jt3VW1d6Jp=}mzID8ZD+8LK+cZpZc>6N)h zUUhrkUd&lC^lkg$PIb79$loXBpL`+F=60(}w1`g7v{Fg~_6|aHBcv&Vl3cd2@_yZq zJ>$U=l578VUvMX=^ItZPBPiOPAk~LvAdaWXToCBX4;2E!IOfZl?f#cd=)pqQxk2Z6 zpcKNzWgyVoAM*q?dc0cjx$a+fogdJyEboo0|GIqw0`2<|ETCQV*)5hCehWlqFU9u^ zx=>o~kmWiL{@&#Nz0?1@-Qjo7#}5+w?{I+mo&x$&vFsF3inVGB&{h+2rrBuF4XSvK;8 z9CSlpRMu2K6e$C4weR0xC zd+ELT%D|CIjRM!XpqDQJ7rJa;Y5*LGuyzBk_PYpps|={{14lryRlwD~eSm9%GG}iI z0;%2tuCA;G0P^_{Kqmo5%vJ+eM?~!eJaZoqNWhVxE&pR4s9*LXu+}7Ad3gO(Xii;( z;XPOD7nO(HRkr14$lYr?9C5Zc=k@95sjkZxohZ7p(b#TR%mTl2+$9}xiW`!ZKX08} z9kSSD^8BmQ<7X@lJ}`3#Il)VUda=`6l5Go(rXtaSb3s>knt&pXE&gh5>&<{gm*owC zKqgzi+E(RO zM<&S3M_wrcSRCVz%MjvmZBV7lJOF^N)@MQE<9P6|~Pfa>a(#vozVeXcm&?1E8AU1I)(N|H?#wsgi)m{3+N#pbL4wSRLr% zru<@VAS?%evGebn02cV4XcH5-YropeM?gtMykeVNwpiqITm9>c1S9_D^G*K_TBBqq zt+xv=N9zqtECXsR&Usm`T9yl!r|JWHfpVaTnP&^9H1qWq%r-!~J}kLa^EY;y5179- z1TI@w3z(1AX1mw^(%U-#(}Vn!MlM$@_PPCP_8kO=C%)+g-|-jm;<)@5TUYmGHF_XW z~()%qHrT>%o7a=P0}Hnteeb;aT#9obMR!)oz;`s?fRa>TJa*|0wg2JMd^< zlfCC7)uH6dnsr~_Uho*v-0*iC7%dg-W6d+Dah)woX`eJ~b!gpxa5mRhIzIh9mET_Z z4Y1#_@=ay@e}KW>M$L9QAlT!wneiyBHJ`_(^}Un|5Hf6m3Ml;X-`v_Oo$1q^>C4is znC#06pW%eh#D`03!$S~@*dBO=>eCEWU{J1v3~efmBZtpSgO0W2|>N?#XE&qax< zqt;dz;%T++qm)Gj-S0|B)D}lc5~i=STCdFP$;I35T{y>HuOH;uTjIn8bey5q$UCRG zmM>jL4S?=zQHMAFR%mHfo=cZoDUR7%b+LK02e&FB?Hidtdd8l~@V|P6U}+~t$OH(; z8RPpx;B^V=_|o(;UtON$3`n$-z|B;mPruXB_wIt>N82>l^^th~XNh_n6gJR{CBR!9 z5L+#a*$rBa@z*2nQ?u`a;MyUknk4s%w!BnXQc$$fc^hzyH~}?B@*~q!V(H!$NYt}{ zTc4{S)9)eEUuG?eBSDbJk>_9mtgL4|Tqb!!8cET|3X+0DQE<4LC?_CSs;5gZ`n8rHU`;YxNXw? zVyI0NRBr&4>YP@2{Ofapa}DH1B{GAomJJ#f6Siv;X>Bo*1bb6iJUsRpOYP6BjK33X1lL=in_$1xr+anB1BR0`7Fr&VyP)UI zY~yE{ayH|{1&!>cF6U(Qy8WZDhoyO-^zm@j}%S|iNvMc=sjNXVbp zniqP%|HHuIW%K>0JW9;2eTu^Pmt*eB8lz*&%Hb6r8O5V!iwz9rlqA&ix0`M4+cZPc zs{`DfYJ&@=LsHV6@rc+Hcot^d^MtAVgu-^OB*~F@hM0gKy|Bu+)a(gK z)IRcH&ek7V!0Al(sQ>b!$M(d=c7uui*B(G`!L&PaNtBZ3_C(8#SVv;5j7nP2bFi(Q zgnoTnWY*4|2us(@A+6PQQS8cj);>O%JwpG3#+Uaq_@*{4cvECgyZ>6}ocr?DfkOM6 z^n@mY6QtBE?k~{T84Efl-jd{z(XJ`yO>1&KNSZh$35aI+8%OMV7OG(V>7kIt@m@_KJh_*mCr@AxQsk8-~J&+|CL+YN6UdHyt& zcVp#&HcOIycD8p{E_kiCfaO$Pb_0yXe&G}glacccMv9$wf}SSNE(yLzpxY(Vm2!J0 zsJHxj{Ek0)R~={FK%y#kKDE_pSFNH~oIN|1tiU5F|9FO0Aa7l+tx&sM z)+v)ddo(HI`^VawreWmn9kC#`@^+Jsq*5xao~Fvo7CV?eA%U772OK4q8@j6f(19;~ zZF7q(bA{co?7@;9Z6hS7_s6`kowH1(L>t{ozhr~O)^S{YD>h}9L;0t>^45R=L3!rV z+qZ50GCRtCy+YWlz});))xWIl)?YtwR@YeVq1Zj~m;VWTzWFVzZsPI@upEw}Ez}50 z-dpjpzi?lSY-4CaYUXCJiw4zKCndwSD=D6ZR|=06sVOKV%J*dTudQakyJlr!@%|ut zGP-Rzv^GFD*0F4yCR#1S59@0d9F_j*ZSe#d!(k&i?)TWNd(onG<2$FaJn}Zut?M{= zFSksC#k&lRPb6P!I2*wb_Jwj#)%1)(d-&K1@W34rNjQa5dolce-+OwO3w&mk_oF{E z7v~POfSWNczFY}$r^P2H&f|9B#Y6}y2 zyAz8W*Zj$_sF|q_>110B6ko~(-9GkBN!x-&YWI~DHL|BeUX!kDKlHKq)bYV9=w}W+ zuuC;O(vd$YN|F;xceYhT@)GR3gj-_JVVzFMf}``c@}}NP%6;r|I+nb`>HaT7sQ#Ru`UzSc6yTWM!RHy45((I3ln1mR+(a@&o`ytKgY`r@OQ`o3E8po_p zdV3(HwmZ+Zt}1}w)|U~GGbqe3IBRd}Lh3I879apmLK4T~)tkkn{uQ5~KNcMHcJG9; zM)SOO2+1Tzc!yft?X-NIKaIq2@rKkE77;#nl$02>FVZ$5++jLKV)*G?x996uZ!4I0x=jN|;7 z-X6oe3m+1F zO{?QlrK;kLq1esfsuIeDn1xxC%I-b+cKDadVBt>96@4URtpzM>rL(C;L29Q}u2GCZ zxs`=H=|~hTe@jP{M}JVw%s~Ho)L2SKB)j{`mGEcnG29HcXpQ84;^K*C(IMKLIZE*i zNpg(is7V^0O5&btTGu2|9_771=DB2Tn`ZA|9+ku?3P{zNZ{W?cx);8BE15!H5M%w1 z$JxQ#VJ_#PBs#I3ObX5|cB;c{cpq}m#aA8-S!9>&{vg>j`DC)zgRmrzq^#%QJ!it{ zgO7Q;ZHS02-?A1ngdS;_19L0)dI;wn1zBbO>h@f40vUGlnr*RSDg|u5mnt3DH>x1S z_$PNIZWT{kt2>(Jk)VcEg^BVV{E1s^U2>e(BAvNv#zuG5b^#q7QCCdIJ)h2Z>QfJJ z$A+kPxegPG!8Q~qjR-AGOUQ)xeu!8d$ z;*tg~JAs&;QP25HY1gx9#l~*)bOX7Uik)@++PVm38*9ju%9fwNkXzA6noM~b%@-Cw zz23|5egZ2u2z@%hxPdKhly&cC2t7M2|+S7I#i49N! z&&)D~T6T1_yEd3)Ok$XwE@Bjdq;bCp3af;ut_!meQ9K(@vh+kzV6PsaLLroPp~n%_ z>doQEnoOkpXTGHQQIyjrL>w&|zjp z2uzc0g2npXB%>8Ja<>^4I$%h>`)B|15L?UAfH4BBqB(uR_y=iKWA4B z>gXRGF&;%UzF&>|66w)@0MR}|BcV{!2nE53+&sn!BAE2F)Lk`GAU%-F_E62V$M`-Z zHq=4}4FM3)=*{7|$69DU%=4pfR@-1Uk&q@WYe1j({G#t}`w(BBw_Ro62*1>kP%2VT z)&Dxz75fjB8hG7V`i|CrpA|S$6XCRp!w>wx!_{$y8Tee=Bqu!jQ9vqNG@_yPYGsO|QD%l(gBWFmos;6u!UA-t17U+is!x+B?>_u^V zn8DEPTE)qSKT1A%H2wDp#e0c+JauyHvY+X+kC134p(l_91f+!nZxJaW5qA&PLL2M)FmvQqtp!Pmb&pG|_qH7Cej{+o8N~9%r9O$AM@khB!k(Wy z;){&ASkc^vR6^F_Akeg5(j8RdBa znMw5{@R~jZtJ zj7i3uvTl2NWWEhqG1cx48``By3R+h_co|tY%BVOe-anaiqnNZ=1Ux*l;;aT7Q$BFy zk%O)-U$J=X40u<*up|U-7~-V(Ei745{5lC%p1?8D0k=our+~L_2neC~%07FX z?=}WQ{M-z!ILZj?i17+5X9VyAbl6G8Em1kRCLb2Qf9)!#t6@6Ai?=5g6vO$O<6{oWqfw5p%I1+?*HTt$~o)k-PNNz`?w}5eC)EWPlz&R%Lqb<}< z&#N%VvOk&p#?cgUI+^xTI7M<#;%xTjFTt56<~2oCVefX4&>kOx|65AJ`L2eg+Kj%F zQ$Qm*cuBd_wQ7HyX*@7@FsUrJ!F zDo!1zTj<3>z;R0jK@UvM6t%DZVq?i+yw0{a8uak?hcgnB7zevDLu1@i)eI0yk15+) zs=dPqVv-JA=TAPRC7gI``W7prY1)Rzby{jwREVYeuhW862suv44;=1_FkWWY8S9$d zON6L3Hsg?vmhrP*;_}95Vs~C@BI9v0$*)=;mtzGtX@Ms$6#leu_eZS<>%KVM=0dT* zt@P@8W(oF4t_uybG12?um0XN5xdAI61)Hm7>#Ok=lcp|?;&bM!=gqg_l^sAqkgQ#W zm(q9z&)cb_{uh_b#>KA7D{ubCBGVZ7yE_men6vQUzjSnZ+Hptc@ZcV4NQ83;{rI##6(PGlc>loj+A z@xp`Z{VF|^{laYcPD}M&*kSd&afbfs(zHRBoe0xbHy<|p04k+9df2?Z`QVD1xyHIA zq^zgXs*ZlDh~aPxlPEG}Xb9yxkNqqc?w2(x*%8>{*bAbL$gh-pG`+Y%AbiJ*wO_hy z0GAAyh5$F90bEtwc!rHp9zx#FnmRle8M3lc1*7M z@GlFgd)MJb+k(?KMa|J}OSol^uXNbSNUs*A`zr1iBu%P zxIFLLB7?;WG+aM+ik#iLh9riB5FfjL)T!}daztc>k#2#S zjl^*&;yQy|dMIkNM)-tpA!1;7c0y2bdiFmS2K#Ax8Eorip$3{g^yCb)ZAowO*;qNH}K4k z)T#XuX<&#rEuqB27HJ4gWBT_(*T@VH0D2lwqFsO@*C%C3BErQK4APi5?>`DHt~0MjNd}@dk(l|&-1gVYNtISBGzXL{8QsVZO{Kv$q35&q zVpGwu7@1p4pnzfyhQ&NwpO6wI{4kho@L0<19DUELrUs`*Yg5L80iBXU%NF`aGFM>H} z4D|DdDy=$$$K2;^p*9bs-MW7Pmwp}!Z*K935_q$63b&}SD42qCTwIc}^@om&q`i*s zUz3nI1~G*U16AB8%J_+1nyQ#l8SqbmW~^gFkT<2{`Bx9iGfSAcd`N5&mXJ6iz<0eX zCU-oikH}tX<~5x>%6G<5D7ZLAA;}N3WdfSrcr0SM;a|egJ zjQuyMGfrHjoL9@RJiET@!<4Iel}W)^61u)lLCH}u))Tkk$E$_WG z0)J5ktgQMT9D776(|MclkJsSOp&dm|r9kNn4$G@9_6dA`TEiiK@0r%uq!JTGQt)(7 z@!qWB^N{`rHBxH}7AB!M&^R{V!{wY;azX0wx{kd2$lA58=YFaF{iU-cWfE4qE$o1F zoKy`n$n4RI-I3mZd5CRs%$M0>UTwh+4Sfy`b2@37XU(L?u`jOSeCjD!!yPYR#<|bu`3L|1(wqP^Prf`| zK^U|Bp<;h&v;kTzyLYglq9^|z6u?T`_x^Ym{zqBq*Pa`oBZk}{dSCvdH1TVD&*kM2 zaJFQ)=f|?~m-d^8$_16Vyy;8m9|Gc+P9LD#uh;(fwEv?4>9@E4t;OsA5#*mQ&3Aw{p;0Hl z>Ct_)u*r{E5a~yGOGt|4&w;1Xsv9;DMX(SL#1kxJQa+@eI6;+-jn9l_QKdAhb^=k{ zMV;<~WQUXUfLAIMzKMLGwT-hj{(ww~mIW-)bG$E7i`fK;xTfS%9xQl2+l4?CO$oSt z<9@$T1ZK;G+)ZM|)bpp#FVNI!p|`oRdURP&f2P^d4x91m}4+W*!Hx^jk8NVuTv2A9-+oZqS`6BoV zoe>iD!aMooSjfyI^lbD>NEA;h=DQgimHbRlIPX~-L1jE$*@?DnWOa#J=oh;JrvByV zOo3bwEKz1~s8T14@kiZ?pdCMY@|vNpbH@_Z_Py?LJ0RPgzY6%j04KEs~5X$Z1k7|wfwvFuTtDJ-@vVKXghn_ZouyxV1iGh zl5wi;9Oc%;#H$&!pD67?)+KPxs&E;PrpuBDyUZEg-_x>G zu%+i@7$N0-xAeK+#?Pm|6*z!S#uS#*{8I1mAEmrSt9qmZ@zBVymsbB6ZLv?~G;i+V&iC>V>G65`nzLVc{O>^; z+nbQDH^d{RN6u7F!AH9B^cyb}I(wh?T@JP&znXq%{UB^JxT1*${gi+GAM7M22Q|=0 z2_ox9Z{lV#lz4{dvPM1nlYmRF4)#0sb0Xj?hVheGiUO~Yq+l8uUR5{|y$)xJRO{?1 zwMa>=TwtwlNFMoUB5HutD#=FeB#RB6{#g0=g<&i$UGhj}ko~S#GaBSKoz=Agz>gD+ zITxs^{E{fmt`EP@P4vaRg-H@_2Tk5hOva2)`JJDmta5skaS1)>qU%z&Eib!%Hu%}< zKYB#{!saOZQKg{O!q32Wgw}q%oiyoqkJCa}%YC!z=VaJ;vW_&ID;O>ph|0Nd9=5AS z61IQ#6Ha@&T-%cZSKVHbni=4HeGz(){pcqbY{b6S8i&60IIs)`u+3R{y^ry4)?;Ra zAxGZ&-Y>zRPJcq~$P#t1M0xU_0m8~RA4F8^iR0290{E7Ik6VtMi4LmbzRzM9;;-jI zYHK=w0!^>dgJCP!U%8n}r0Pt)p(W}@jaIh)Oy-RzpN75@ zWD_fPB$NVQauVAXq_U>R0;~No0K%I;eY$+(#dtWB*J9hPkn}W_-s$2p_D%yqz)XF9 zBOg`qxvx5^FE}Y@aU>9NV5(~EkGA7p>360ygU#FHze(fJ9gQpNDUc9;lVNp0?}h&e zvhixp)LtK4rGbbf{*FrL(N~i|%>fu)*Wba-A9*3YI5(3&HALrxJVC#`DZ_t&1fs4@ zj^8OuO)BfjVAK15@&=)DLANfz`PPz;H`F5c)v#OA+QM|UhV9sjUKpeKGh3&9%|ugs zs|?Wt9-Ov{OpU5yexd#>00O@OV4;nC)te;ruDUK-*CHE!B8gC(vJxat3R7AmE0vo0OhL)eu6$_}85&xdED7|aK< zjfnL$F7azTn;YHz1*1DKtin}&a_|t682HHZmn?SpL=>WIJlj0Q@nk>19bX2&0z~$3 zbQQ3jhAA;PtW~6!un5r{dbQ?mE^F#8J-p~wjDAmepSP`Qs8heaQaz^3=h_~g|Ej*5 zyR2Q5VmANcn|Iw>uIRY%*a~4U`iP5KFd2J0<#J`sjBp9^8Y6(5a`I7hfm5l{9$7O+ z_n+Lal`kiv0qD1LE7ZEN>%eH%vB5Btt$_P=ms-dD67Rzu(7N*l(Pg7x`3xlY;CS)v zxEGx~Kf-99`6jAX&Z@5FuBC8}&UJ$t|Iwr}GtmS~1sB?R;J@fS=-$_GcbyIQYM^tg zCB4dk=kKTZ3kA3J$u%S*!W_TmZ_<$d|6|kT;n@*D+0eR6a}PUlAgcS9A!zTY0fHdx_jAq7hmwB=!wQujI4vd?Z0!R z#-Uvr3w007Gv*b>FFHTKeq+cAIjOzW`p(bhv|cU$HvNgq)Wds#j2f9f_z=m8w8Kx5 zXH$OnI^#W;qid0~FrmK`g*2O2${$b;jr6mcw>yik!YYePybS;Ez|kiHqD}3!1NVkn z*tRQckzqZLg?n~PoZOD1AbB%B6M&9$!yk|TplX5c4^+ zDTF8)W0tyoFrEOf2gaFa;IQ-OP>Ik>HJ?p|kivws(Z@{_C#G-|{2~-c^wUJXCt2^Y zSwVTd%ah0F?rhdQhao!GMo z5hi9!Jls>uQo*x|UMX}}B;z1&&wSP93Ym2PIDcX`O>w(3gs@nP#DW&FzUCa|$_@X8 zssl~sm!qwvkB>;5{%|oU4TM~+T!8#F-$zzfaR}iv?`PR97@HgPR!Nq7$!2nMM>M?x z8*238#lo*+(svZCBF2+9sv3K4&yh2`@=r?qPB+ID)FUSoZUe8!IiHj`evMWKohT1p zFrd2K3m`Vd*KF3of6)WpB z*C?_o*T~XjO)O~>lT|bSr$vb2nG0WWqj2=l#Z!P{R(VB7ggejEeLb6pJ+v^88~!$~ z^E&E&*3Jo=w-kK&JZ{%9PuE)>PtK9|Jfl3OvW^u|D#6!&VL#=U9DEQTtiogpEv}pes#MnwXH#t!V}jctHS zJ?!Ggz^d~)RGX`2+Ej$Hc~jM z|2P$`lfSCE=469JVV;4}b3n|+qzn0)UqiKiR{UyH2R%>yTAp}8Cdu2)o?`c==1uWa zqOK+DtGCY}LQm%yW(oZUKfLhF7CkGr`0|&*8O2Z>CBp=GlqS_j(Vgdej=c=5IN{)~ zebIt`ZI@O-4l)A%Gfh_3tYX4JuUr82Z4?RoQ#3`n+n;CY;=`;;rd@w*6F94d>C|hs&mT~`s6RpFF#cN z5c$?-)s@LF@1cg*_YPLgeaU#!<&(FdA~4h_gP|Y(WLA^Pa#Ytdo~FL(3;<~RZ1hC; z9(moH_4fbxVmwWD+^6ZBg7tl1?G$&&NaMz?%~h+;#&|tksG(T^*dr)t&BcAPGJm^_Hi7N5hAV1Ii>+ckl`T z4PTO3(kDi&k7uY;?UH>LZu(uA!QYg*0CI_E5}SaCb^mXjA9HRj>sTM>#1jvsZvKa|v+I%K(MglCr9eft5 zf`54oRNl-oJ6#T2wEIl*jY*~GvXJ7UnItItb!&T#_ZK!hX5^EEbrtz2Iy0iD+dKgI zabC~AgTgC7EGgg;Kcta#o)5JerR0yfl-L-$3?RMO#(jdP_pRUH6Vdc z87rop`h|+#Ihm`#{?ymBk?=o#c;P1g)Fb#<*Q`1lmLfNuqKjZ{JJaxjV=iM!a0J1k zt>SEka8!rn8jJ39-T99yG6X(E{B>3Rf3f%G;ZV2l-?(n~P3{(*Y}u1#?8&~iVC++vnVP|b#xjigT|=Ah&-eL#j^p|L{&}AJ zpAJWPcU{+co#*S^&ua&8EZ5cqiu}0NBJg@gS&w=k05FVhS2f$P^7*N!rokwl*7nl# zemY!z>O56|4WAD(&#hy=?iCxM`0Ef_0@Eq#cA z{bv6S9WLb1)bm;jL9UdoEd1~(KL$H#_;G4HoPEu%v6Ggdk?@D#22G^>DCaIlb;p4D z)a|oAGh>=X&Yi>58vDSbDt;e6f;&k5{B$v?@brors`5s+DlQ(ADLCV@cS$*^p?1WR z9#Bv{I#%m4AGeVkX9UfcG?+jwYfe@5ieUVbn>l^Eb_@_1j%wIk#%70(kdW6^>XRG5 zQow%tX$yxyN~ap11@8egphxPu5>gBG!zKBx4iA4$f+pm`;nbN|tb!L1yK#G83AlbM zcLpxe3O+Ov)Lg;*Z1naC({_-M&(i3~&RJjG`UY$WZ{uf+$~ zRJiKoM*R55@Mwvhj6fc|6DCqZTNxn-T&_Y@jrLJKZv9i<=Woxs433GG_IgQM^%XG9 zc=`RxB2Ye3S+7q0dcOK~V|xeJS(uXI9fnq$WVq6I_Hu!1f^58|HGjUdI1A3DW96Xh z0#{_dy$yMCs=`z7udd_&@EH_eFs$_x5v|RF2nz}J-`KsS1V1pm954$IuY{H0C|2n1 zUxLcLF?#DLX!2R_tOaqI+Yu|Cq6~-so6V@bKwH3a+eCb7Z+|uVE5747Jn~@j3pJ=J z^^_AUr;m5oP#U@g_{>)(b!!kTbFp=MemV5P9iAWEFZ?YOc?fW3n%^AWfTKUS(86l_ zJSTfEIhy<$@;!NxsQqJ~OmTR;zHm!)!e5Gee*vA#{(R9Oy!24;bp2a3#Olggm^Wbi zU9niku!7|;X5TXzzwD4HeY1oA>JmW%Jo0lHQGsYOd^Uk&iu_jc10rfmYf-g89mPOz z@+eI_cV@&Jy9;q&4F~2HEU8!hEIqi@$MDP-G;Hi#ITg43+}65>DD-hFBP5(z*Titf zYhNQhnCx==1+Db{W8Npl`q}H+#j!BsVBk5hgQ(=`deesPREEo^sWBCY+8pAI%{H?$H_O>n(u025mzB1GN-~7LImy~X8iV`V&s{mE|N2bXf z$2$2%=MP@EF=k^^Hpqz-UJR(Kxmd$q04g$vZo)S^f9?FOaU7(RuH^95^&i6C$DC*X z>QbTpr##i+pV^hdi$9MfZz%|tTYK>Cmws}PZ0JAqlS0Y)?6)Io_Wahs4)SWw4}Wrn z0p@<47WVfxbC6vtZQB%{Hw*X4qob;q9jkH5T&JfBADwu^rJwo?uA+G44*u^h{fTyq zzxcz`ckAEKOnassvMW4Lh6jDhyy!0vk#kp^MbC=7Ir0auwyluZHZG-0Zv>Bj6;t#c z6^?iKY)Nq=TlzgN$wA(^FPwMrVx`xVSq?FeviiJ%x%pBgI~#9v20w$CTncYZjgM<{ z$}=6WXQ@l~_@gP^L!;`U&xiiDnf*57{V(kp$?~xS%8D03@>42=_rD;R5f$9xs zPWi4ADvU1u1FosX8Mh)uoSAL~ZMy}*t$rN^%N(#7=ll2b|6fRFO+Q)RwCCCy>opkM z?A!S!I%pfy1CS8T8%B*LgWId2YP0b=KKT!KT;hT7bsM{F7hCAQeQ<4*f;-n^xxa3T z*f2ARINv}Eu6$taUj3S>p;jA71--xoM-A%Rs3cgI$b2IsU8TCPx=dD}@Lk@(1&SFM zE5E4$Zt$?$Bx?0D3dxZCZY$r<=?+LCqAgO1@g7yO{R=Te#3n2q;F z`n&vw#Sw&cUgAO0BtC+(9vE!du`t5uL%7xk6N0lfl*;@h54rxLKpmPk3}K7UOF9OgOo-Alzw` z#6hE6}mmu-dr9zP{3d1ds^l}3fa;i#Lvo;HV{`%zbIY%l~orfzPp5{ zr+Q)`(YIa;j+!3aG^cYcyS6#r>tjuLeq#u$wsxYxV$jnN~IrL3Fh!fg+krm30=PlUZk zhtW>fvs9VDm|})-LH80pWVKWcgbiUxBN`(8gPfqs;ELQX<0Wg)9} zsDzCdckvH2T zbU=j%(rPPvtk`&km5IaHI z=ixrGnvcX{cG(`HH{HA!6w%LWA5-YAu>@5~s42bY@(UDcyEH>{W#x1@00v2q;YdAE zUK;P!&Gq^>Q$A4Wi-PpD?ArTkEJvbJ3Zqe+4S7WqNbtH~*2L)xdql|mVdn1BkO)h6An>$Jv zyPayi_Ba`F#y`sBfMcW9mA!O+5_=IpY#<#f;i53HNyqiFm~%s{T-yb!gqbu!+NYrx zAbj*?h;DVJKe)o@%t@H-NmaG|ecXoUTju&~X__kt5&Z^4LZ);>ZBaE0ZPtS!wZ@n3 zuYst!J=WQwD*?0Av@*<_3|sj#Bz@{2*6$3BW>?dX?=Le-K*X-VUkI*#xsQFM5$4i? zGH+}14zY9iT-k%4*PI-Bk-vk~-R@EOO*4o%r@S^Aa)-zINKN-A6&j5dWcNEsO67Jo z2E%I1wmzHaFU+#T@(JhDqU%N5eB13x$7|cY4=&5EN@68zFvIHXMI%L#%Id=}`2P^8 z0@eYO?&%X3q}v?1XXrC(B&ds}q0fX5dNOcvyNtDjwR(XBH%XEdK3ifZM2-Su{%h_V z;q%JG+>9>?7URkfP07sLSYGCvaVO7Iw=E#``h&5V9Y-G)8V%N`K<0-8m=h`9Ve~GF z@vM7vC%>WQXSx1=mUG5q&OcB5wfIysWTgDq+5LO7lkW4t@U25?SlSWl7?A zKs)3TQT=KjUHL^GMj;_s{Xpb0)uIGf-aX{r4y$xN1Yjr*@8>f@t$_xC(*^tCV`n3XkO9?#V4qX|%a?XP)W~)vVdv5!If;$!)kaSDYv& zeL1-@`bMiVe*P~)JWy7aFB@eW5eXu9XX6568jNB@+u~xGPi`G1WQtB)zkZ|!X=_R0 zQX`7jzDO^fUosxD>|r~cpbt~qA0ysZYVT^@;EhUdBXibjiYWIOTVV$mLZB1f`HeM) zjQw4mFRymU;<~%~N*f{Prll7$7Y+z0%CqqjZuEFrH1l~XJTBXM%{e45H9&m3Wf+Iu z68hCWszbmf+wAN_$h3-enzP^5nnuSy6j#yb9`#T<>dcPB!M>{DccqxQCjTYRuyh}9 zC%@u!Tv!R&quU3)8opvVw$Rq>CEiV9gDeXZ@hrE%69XLy?)HSYEa-Z|FVU^^YNy_UCktKau5wW6irrJr#1z3BGP((-FkHy@OSE$Nlox0m#!DLD-{6ej(l ze8^Zz@Zt7QqaJPp2=_H(ywvUleM=qOmhSQo;*XwDj8*D;tQ97XKP%mNwU0Y=>EvN` zZ&%)UsVX9`c9Dg%n}5KHIifi|tiYGw-nzlDZ_~)2*NwC5S}nrI>=cb|f5_0|pz&G% z7Pj3og@U>QGUw<74f@j1Y+~Dcl^4FDI9vWAXOS%v6A|b?ZvXQj0%U37ImXJNK*K7G_&RWhc1YdW>HhD`JuOMfZ6YTOv4PnazzZh(5 z%25G7_FDCc%thgyAP+tCfa--C;i^jpNG^h`-Q8$$#<;Sj(3hMv&#{W{c1Fh^F@1D;ISfY za}~1zoy)@U;?0igu9=b9s^FL7T-utwTbdVpR3Z7gsyvowkF-#ps#|5?TWO|VodNB& zZu!{MRafKY*|?H%Awg|Z+9OD_eH_8dsK;ere3-m?ZSXbR-qIWWn7gALogf zR+v>Ll2tIQz0Iq`-q{gAiS=mQLz62g%GcThd_=S(l6fux|H!@#m-g<2OlbD$`{g_l zVRt}*4&;Fn<*)Y__NivpTnnXlov?;owG9q?njO|+HX7-{v5Q+1hquVW7-M&&ROsYL zA1B;-to#O5VY-`cZT$&PJ?FOE^Ot9h39^!DB86eT<;2R4)sDCBz={8j!}45+g4rFf z)`#7wIlDdhbcBharL~w}!!gR<2;b1#w5mwzQQM)}Sx@4#TU8@^#Gtz`*h{k(j3p9k zApz$b2jy`MAv@Z&g-+8#V@oJOzJg8U$0P`a(6keEnSMY?*OAyN2KCVGNJhN(wQi_I zBWW9rLcJ6Y4+-#qZ1Zw zpgZ;|#qr)SYGVE&>D1$cN1(%f%Lf8tEf6de_2BW+I5+;Fd_>wX>uxBj=4F2B^!p6z z;?dTreS_y#&bn7MyOpI2wqkVAc|CCdm)Y6aBCCMsbTbvV`xP{T%Vr3h3&pXa!b31- zIVjuCB`zpJoI=RwU+_yQ!{i4NX?y5+s=0!+0FL1X7x%>tSIsGeT@|xW5K{B%CQ9{ zQ!)UqIecl+C>bXw=1H77XvmM2FZwtb6oDoS8d{kqW#*%(ou@<=-qeGrqxlzn(FEM2`rFyReQl^<!P!B6=RJ0@ul1CPsSog(P>NX?4ei!pjz% zM=+$6%HWD7vnQ3fWogT;eF~xRtMB%)x}%YEZOjjbT@Tp^YnVP2;qMT2?jZ%gT3Fem zDPj|M-RVXx(!b0s3IOV6se!r6=+;mG|8+VR3kjkAtH^J4g!x3a5G3N=YU%7~laNJaKm?*(Hy{q$ z>umzH&0%Nz6Cr7oTjM?6=1#902e{rq0(k4x-(Oo`it1;t<+7`X%F3bupzN zs=)FvxjbVv#p1F=3EB692BsH3=uA_7=r5I*NAWg~{H(3lpSavnLK>IEn_TMM$&9rmE0r zG;Yl0^T`q`^?B&(idnUE#vSG^@o$dNj#d_#US^6X8!v@RDZ?tvXyO$u<=Hty*uYrQ zL>MHV4I|>*v+OC=`ZUWrOqOyw+7`muvb&l~o+#$rAv)Jk(f;zKV7b9>9^%p2|M-O^Qf|DbJgw7DwB!qT^Z0+Gl@qeNG^leOvTE}`~8lZd}(hl5yzG3+dYXibSXJ= za>g$_sjz5%gjidO8k(*sXn|^%#rs^Mvv@LBqzC9uj;9J-wTD7sM~z5va;}vxP&5Ps(a>) zvhkWDk6j`cKw=!Vp&J1!>e=?v`r*clS<;F4JC)8PP1BlBrWGHm9aP#Jd$_gqGUiVO z#93^QB*K**uAFyU5RC^0Y78Tq0$5kKEAdcR_F4a|SSBgm{uaZ~tjsFsZ@doyd({}l>%kTZT*!hx!B0LqHR7N=+dl1k) z9`G#I$N1B^@{~Q$@bcc_&be%;RO4g6Lq+xipUMx|2$!NGW zlCt*`b#{J;NYG;q_`&Q)TAD|CiXQbYd%9o^2gVnCdH_kh>5wk=>StEH)4u_0o+|K;Uj;(Zd|{wQM|No{HhQsX)2h4;Wlu$+1cJ#`sWhm zFAGz{$y(}3rM{yNMa|v3I|P^Q!qVZd&{|au9{VvL--H_nV{I2?v~e44r~$Jap^kY-klSp_8H_@I;Hs+TLF~Y!?kxVdl3~nrCjLd%jHUbD*_bnp%}?PC5ziCmKs==r859ho?deut~-3b_D=C? z3Lm0Tsk{eQt6tTY9=OTxVBk*Jlkphvzgl;1yWtvwVBmD)`6|CSAG8EQuf9o?S=CeO z2SG1j4U<&nU-$W$X;y1s=4o+i0a4V-&Jwg_X=!^QAS%uEtvr4Zmh1OiTBSnu0f3$} z)!2-HWnX^3sb-IwzcKR=$KsdWMC_MAY}V>y&o!!EPVIPnIl)J?%{vd?T_|dk)}esW zXsQ4$)>_^hQ6MdNOOPb@NlIhyyA^ZSo%ZHZJ}2Q%%a2)?JE)WnCt6hOkZMyoKVGl6 zs)7%j3PH?SN7_@;-i~3@mlBAI1*%M~Q}LYgFVH~|lFZ9b1K!p5_*3FYp^zBqeA5FK zv4tFl+r*7U4o*;0&)zgKU+AM%HiiKR#j4FWqUb9G0tlBxbVnlQj4zd=ehW+lBBt>a z0fjbFvpOL$FOq{WI%C<<=sK`QW%ru^5JYV3+L?&)i)B6cfnsW`)DB6=oPVDVG(%D4 zS8XvHS8xQ@=)xjbz2(j3oRLnHRg0kob!h=P4KOCoR+EcC_~ru}T1Zhi>T3k}gzsw6Yq{ z1p(M?uPOh!*CmSd=8F)ge5zpZ>P!;p$v5~|#)ck?S65ey*-Tge%;<81ozk8?bekAo=M#-~KGZBS2ain?->2)8bCFmOhXOYx2#~U|dMZvb6 zca^j44mpJQNZ=oZ$-I8|WTB6zXjs*nH+XZxc9zMfm+Q4?BY3tnq`sO72&u z6{Ea%P?n$vVIxb52SuE7hu*2rG7bI?y2|4FF^@;$Ym|GI6(>#%SGeZW(LM1eC`S*{ zye99bdtJ7EtxwZ}!Y$Zw)N=uZYiY){cGatEW(HL;X*qlc_9!v4tDQn6bfGEkYQ18) zz0Eb*8jja%xubvvZHB%{Q{L#LbM$a4JRN?MRje{@n_Khw#XQD<(x_+gph@$RJap3q z>y{?3237ZuoZPZSUCK9tsa5_Rml0ZUE=MPo4A)P+sAw(|Ti)4ac{}U``Mg+JTz5ow z=#o=WO?DV%){@vAf)&9>%{~wmRHaz1^Z)#reqd>Ew(=I`^E`>#w47LW);3WuAPZbf zuBdebp~FRgd2$&G%SS7uAnJYM(uKD>HdcI z60`o$cO8QC#pa9}s{nA{%AZC1I8Yq5M)>Qz3ke(GsEb*XgSS`4mS5qnD$@h5Rbgbd z+Zk=X3#-(Mj#$<`C;5e&s@&Bj+>KUvi~0t=dStFVzRHQ+-yEz|I`kTZ;wj{4R=S-v zK2fdDbnJ6B^nQiEQ{~B3gGf$kOnWa$0#{@}Sx6cZq|7Kl+0z96{CjD+ht$>ls>cgw zcQA(#G1c1aJ%E9swJ+1RS;YJcwPh=;XV+bQ)07moG` zY?``u6FHtVryTj*m3eas@@fi@TMVJXb}I3CnH(y| zR)rYgaHvSc%@N)efdi2{mqa2LQQgjoe~G$Zy%>0WQJvVs7{jTs7gz|zU69m4@xzm{>SYSN~dK{gXS5eLh{f(|Cure zqC<0!^4MIPrrnA+E#VK%>PY_+H4em7^@c`Mq<5PIQzr}uG<_Kmu6$H-2ItOD-!^EY zS-sX{o)`8>dII7?*)}e1z=v2CiaDNvRF00_SE>)=e|q+7zjALoIl7QTmxtn3Dvx`{ zG5@O-<)IP@LGtWhX~kpS$B$rk+6l z{d9S#g9uSmc*CAk2t-5<; zsvRJLX6+=!7kbo(+4AR{UAB0-JVA;9R3S|5AdD!B+ni0w$%v_|e>Xd`M435OrV&rg z$ja%?gdry1Hs6yZOy*hzKK?d@g85Ci9&C8Ip-9PYe!=_Ycero-IG# zpEQ6jtwDz+?cjzPb4wNFmzy3f+m^smrgTse&uLV5_2f?!*#+BZ)%^Gb(W>hIp=JkH7Jct+mRRLJj60DY1^)A)Nr5*XiF3 zX(kL`A*M5HEb%10@RD|DR~G1uzugGID4TB$kivq@R1`aDTNNiN@xgvkm+Y{aqqt_j^A0+1RU6qY}ki>LK58;cr`8<6PR%ud^(Qeq;mP$^cZpZPJ zr5l3b!={|_ZK??ttOoD|?VDfALp~n+5%EY1eR4?Z_}Cp8*Cq+e!VzOkAin;lmwUv}QOD*9QNMWj84`^7b3%7@RxAH>41 zL_rcg@+%9ed{R zVsIwD&Vho!_4NF=9On&H_n8Y)&&J$6&^5ccuT#=KNwr?PCkkWY(4_Z0dxg38n&1HK<7Q@V^OM9M$zI=AqlJY@}hR}K%|65p! z&(K2uVeR&V+}1Ogzf4tEbGu?JD|G_(fUj}IB07kpKmnL%E)68Z7d|d$Xg4EDCbs|T zn!Sm%QJInDv!(?_?1-XtyQm_oI9mCjh#gbv1zSGobOrE>tk-<3XVLE1J*OvK3G*?` ztle#E$T*I$p>lL2K|Yotau{5x0ZSto4ssE|Ew`(Mt7r6 z)zZ$=5Gzr1cMO#=d53zIR!d)?2Vkg(1@h{MH*uW4kc*&x{p?M&^PA6&qFuy*jB&Ag z0J&n-nodGgL*SO�ql~CUT^jG*?vVj{y&<&0BESEaKmK6Kxk;;HPmnqBIzS8;pZWqUm zKaZH9hPup#2G@Vb8gsW|dXxfjfsm;sr6t~QSCt<>)69k{yuly;#jk?T&@R2u8`=h& z_;vgH3j(G@Ji(52C;F)VF(xV@7G@|zS%}zEJ<{A?gM)t!r&B)x9v0Q{bzOS5zU@11;+-;0Lo8|JQ%~?<@d?OA&Y&^;dmfHR(BauCqQU1DP3Ipbw7UwkWu0mGu`A61Db2U!gei34Cgw>{ zC84yj10Z5(&!<1SY@cmXnIBhW$=#Dp7nBjWqVdl*jp452+&6X$Z|g4-B*||vZHVQN@>(#_L^*lZ8bT1 zo~~i5S{DG2F3@Z3<;CICj%zSp{`j`k2MMjcg?1WUc6CY7R657_rg`CiG>SA$ZN0h4 zQRdw({$+Oo=DzSAdK3?Pp&%$&{H>$G)$z#|#jt3W$^NK+Nw}d^=U)>3AHs!NKDdXM zk=1iuDiH^}=RDN^JMq_AWT$`BP+iVMP&2jS2rwnoMq&G~nbCaXXoyt3-nMCe-}eTt z4ajgOXj}YmqNn{O%z9;P0JPZ*#W7Ew_>Xekyt_aSHXfmnG&>m|6j3(nOIjjKctqN5 z#5ct|jOPXiz$lr4|M`E~sk;~DKifL@EDTFuT`+)q>D6oHf~NHNC79|)I@G240pq;P z-E+k|pSAqq_kbM(I#rW+^utc520B?dtwW=iL_yVTTe0=(Y=Xg9BO_?&Fggf2KxVFj z#{v9T2R&5dHxTOZK zudQ+>K_b@CI?`ThW(={~O&>^c924h@Zs8z20UaJMO%I%28$~qfsIhE1=k$=85~Ebh z*S-OXkEDX}G;?T+nvwv+=q#iB98s4#AI7bb8)|3F;u5TUvmdd4*!{i1j3MwvA}q~q z`%G4nS=;-F3&-RN4_pt_`=&S|GgtLcW^vl@G)1nR{zE$-D-<7wYxnhl2hUa+sFrRx z@s(rI!AAM^nK829zqud=*%>2$MFNUCS4Ep2>hxzS+wtq!m7ua(Mq>84y=3veN3n8$ z>+(9wts}Pz^3z;_K}&frXii`y#4+#Pppmp><-VA$f5+lK=eP^3!6%4VaeuFsCeh7$ zW6SrpG=>&RlzkX(bQ-qRL9!Pse0{unVHBdC^Wf#HZ%VAlF7)!_iJF@G-lMS0f!zYw zjf4!%z8aod^@nHzh600^g<>T9XBxRX87qEhY%e&Ktp=NY_DJx9*{`IO5#^LpU!E++ z*Tch1ra{K^#5o?VGaUPHS`%SiEGQI2Bpje^8hLd<2 zylVpOGI8|TgxacscXqR)E`?XWF{Y|}%_11Sm!uwWCWXs(wEXibH!l33w)+3wwlss-pwUDTOmt`9^Yt9XnE?c zogz3W47{YKGk9wisSY1}*(iZ;ZQo>Z>em(foOK6H^!heebIRX&C7G;!DB1CDB<)Ml>voc+!e7tyZ;p|FQXo0C z3?@-ti)Svs_p7+)hHNTgh#2}-fhKLR&a^uyVzHf+eOtcEWu40NCPE*de(hBfx1F+x z)qJOEMHdCFizNg?Sk-8%dRg^M6E7B4a;C~vv>?hoVuR@+3}Si`uq9kVvb>_GRoLu1 zJ!!diW{Wewo;TiEx9?zIjJ&U?vrgZYu63hm(!E3NgfORcJkp25@MW-=)5PqKkey4O zQXGW5bj-7cZKQ0MN*tTuSA`8)E8Icvg;r7g%eRMZPQ76H3f0w^0h1^deqR!A5tC~q zA?gAuQyY$(?#Ugpb$ufR7H|E&xW1@*ZU}Evku&XTq?sy32+<`s>PN127=g5v%G7KW zeUXH%^}F?Sc|rdcXy$C3o6TcPP<7y!Yu)<>d!aJCl;5zY1t;TXCGg?=27$pPU5&7n zx^5?BGamD2So$XLLGGS)+fnVFqVz<7pTXJSENk8KVOJwpV3_h_PaBNo1)6^oRY;6n zDEe6h=!84iKGzw7k!sj?!wS5i#!OB2<3ICq>RK#XRTapqDSMsh_tsa2;cI(l>v8z} zfMaK)Z}6;6xXE+W-nt4o2HDE?e%nOkr_8bgnhj_XX*!iupfGpWr?agGM%e2~D3z$W zKi4(>4^b}UfI){hv!+N^cEKfx&!(;{2~^I(=WR<8mkMri%2*3|0dD; zqV_$lJP^u2Pu+AM(4p9XO4HIKi(90-E(l$u4aR0;(i?Kl&-yY+?f+GC>k*%Y1E?#Z z4uT>+8>d@t*Uz!PST~OQ$CLaTTM@JZddZ`*M7^xw7u8*?8mlu=$&~w1>eQ@93C%|~ zvR=m7w!||{COHKoF@+o%Rt5V^nXOVX4N>wgvI~ECwq7c7wi2wn^eYDx9f&zHCY?lx zk?A9bnRCgXeEf31X`tRWRVZ+|s!asNmFm_#XYX0i68h%@RdR{Poh!l59+Y_U+x?~+ zE?C`;X)o*JE<4~Hqyt@)4i8@LHgX+II? zphOK8oRsDE@8tiSS2pU@#rpBF_vm$eXS`MHMPv;Jy$NmGPR;00vj?`y=rz2({|1Yq zF4|z*v{h0ehmg_Q>d|r0Lvt3%krUyn)*|kwWwnvqS2n1qPxb{t+sgaCiJVMh?4#MG z4>4jU9ismFA!0C#q-z{QG8E#&@}h@?f2=k2uy9kA4~6u=$+$rIkstI-m6T}rmcqNg z0^3(1n?P;`hShKwYWRSm63MfAicxAA*_fxNIkk~)tzf$AV6I(jy5UgbnL{B{U30&Q z_JlOkowO91jY(}#p7m!k|CO6Hr8(t&-U8x{^SX~qXE5sZ3`Q<> z*+q#Vt)jdC`WO=ws_3n+w#iPn1JSA^Rw`B?>r)h)SohWRwf#tZtgZH&FdnJs@F%!pIomP*ViK*H(ESU0@sxaz!*6@o^=TkK#! zw8N;9v0-ihSgfJ?^*%Yr=_+Wem+UF=ZN)ur2y)G$D-qs4UhU*vVvmc1EW$!$sAW zmuop}!)#Rrr%)Bwj(8GLm))xqF7DI6TA+z%qLNyR8!7o0)6bQ^uKOue|Y;NWK zl$wCv1p4#7avF+O*oQumS$H~pVE%ItV@Q>Qr)=t6e}4d=kOFNrE>T)qg}~tNc=n}- zhdd2u%kS%zqE9>W$cqFY!p?5zv`hlsX$)&Jt6KyNE`87RqS1;zE?P%4C zXsNT<5%r%11kbBgvQ*(&ms*9b!Q|%A@B7mw)0(fc0)-=+;!_;U#M>yo{esaCRE=? zcROwc9nhL<@eqdCzGNJ>QVysgFTU12uqB|KX>NA-41!9NJU)QFULvqD?HE)h_M>MpN;p)_b3_|8$?n2$i*@yG`phD|MV zT_K*$!(3o?+)6@!(@7DBiJE<djL--~@?ihg`U2_stW`AZ75plvsZA z<8w5vN{-7GyBQR76{tQgMO(Oe>~SYgw*79^luJjY$72gm z0M=v-bYTGZxvH=4^tw@5(aS+T$__~H=j6>+_x~V>GOP_IhpCYhBeIQGFkm{B(~~d* z+rq;v)wW*_v)^-pH>@xm>46#UPETf62<4nkKTo$D8*eRb%B}Y3B2jfd5s$pW5yAr- zon$z1@mu`VX|{*nl)y=(mhyj}Q@J>GkBgmX)? z^;>D0D9udmNQO>V3;g7oI({TZO;GLbt6^4@S`)k@5b}27V7BT>^*$TmpSxAfG)>f9 zlqA~KR5?!pOyPO645kyJy1D82XW=EjS-N1OqQK+@5?PE|nGow#PH7gvfN{Y+DO~mM zjOE8tWFCGh@=`~i_7AY~4i;%tm5w^`gFSc*wx(#MYSjdE+9G`)K-<8Pfd`F$e5TDL zhqXy=;W+~u9%Z_YmtPVk?N zXcs$+pMs(zv`HA58eL#cXs7~aJ?Q_?-`3Noy9Yw4Tl@wU2y;RDW74>;228CEy=DpA zGWGL5m!R(%XbF7pV)<)w_SYXwf#wEaT?)0?Jxcf0<<$qXB^W?Cb0MqBq7ydhej2Nm za3fmNTD`;{Dcz8BW}dh}=#n(`kIJ6owu||}URp1}{0vixSd6hnOrZ>L>*FpznV79m zFJR|+&xk9%{0K}1u7XpW9Mc zEI_}m8x2=>dNQX2(0YEQASgl(Xe9U3wpy;Qf#Hxr4c|dCwqm~_wPv?m=^N$m8Qd9Y z2}T1u6Hk6(lm)+X1Nu8e@X=7~dB<=%IA1m2B*$vd#h-JiYc8A_`g8-s8E@IcFJjPR1Uz%99*<8tyhzfa|VS>lQmi z*$G(f&JVIZ%!II1ZoMgE54t^BN@o3Shz04=MWQy0iRCWwIhxf$+xi$G423iGTB^Ga zVO(%PXN`sIHfCc70R`O@zrHR(Pg`_$rb7=N`GjMLKjZ*9r3ge37}jBYOySI+bs3cJ zzSq`pA?w%ovY!R(t;z<325sBt|K$~{L1kCzSMEBcpCV{qf#;aLds`}_;nszk58G!j zE#~;jhMrp{MWUu@ApVsEyt_rMulo~JcR7X5^%prC41z8uA2_BjKm#A5=9!=!M1niLWE9a@Sl+uf&mMaShdn75H5x(jh>u;$dhK~TFqx0n+#uz^dCYZXIjNj z{wg}V=}q+J@p1B_gB+yDS0(6fpe4WMJiR1lZbtZzi=DQ;5`eoTV%eYsj5&2DWch{D zuoPk2niLZrLIk=YYQ^-Ic(mPBnA}Op$4t&u;g&qvX?|qmY%T^Peu36yn zztwz`TrS=mo6trY|0ws@5fV^la=#>6RZ2l1*4(YSH_ow4#QAhg(;%1XhTHRxl?cmp z311D}32Hn)_;rKsrvl419Mi{9cjHJ=>4%u+*O0%j^Z}fQ@chg~Yn6-I1djiV<@Vu{ zuX+ZomQB4#W2BL57AC>qON#PN@Zop{-zlp@1yT1gJL__R1%f&9Gp`)J&n8gx7gq9* zb#5ilkKo_SgHzrjtNG1Nv=)PO5?Y*f^Fm~@$BIvOmAZhHF;nsM$O%i}bNtA7*B=J? zpOumW;B}T?^I~?EHM*q-)~`iPI%X|%J;^v3|NnHdUvun?Q<(#*SLSnTu9ZW0F=!qB zKhgR}QX3Uh_zK?eUS7*bGxX<@+}1Cv;5YvR6@JaG4__8>uA+KWV*TE)m7$NQxVFuV zg~gXeO(*@42nF`<-v5xlf0F5M49T&kjnLHzbj`{d?)4dtKek)hH%c0JGT78n0bI6i z|Dp2WjWM7To@DJ$9)KW5@(G&neymFIk|LoBap6f3Gz78s`=x8FIP9pN@S= z@_D;HBl7!|)j+1I)${xQdH>%}&ZGt?Z9JB}S7Qk=Xs`WrZNy=v_i)^Jiyn?*2_aM5 zOa6o0e6Ke6B#sqnUjs!y3eF21ySi7bchK z8IRqruFY?JQQQCqO5A%3NXDUZ@IPJ{`q3`K-o;k>`#z07*2=R7Ovete@q&JrD}8Fp zS?pNncB$`&U2IY@1Pk;g3^BrsYgHd)4)!|X5MEPj+V~WK&aJ!7-|^*On&1(}Zlkt8 zAO2D?FZ1F%ySc55xz#E~(N^4sD)PS7tSkhxeu!Qnl2;ed%hH3h+No<7r=m9ux_NmR z?553n5tLjeZIb?e1Ylz|Nw(hqRw?4wzQxSuYEr3(PRRNm!@0gnMjIgv~L4e**j$&h{Tfq*p=f+8OvDxQajwd`(CQ zp13o7-y<1-^a?(2YHbI5*?8-a>zwKslH5j{v^eX%zUhaoXeYs%fi4uI_y&xAUB7(MEG5kRw+$vNmvyveQX@PBlW_m!wd99z4;U&r0 z2>a8*0B91fS8o63x1+y&%WMW2D~KblUkk&X2VQcc+bGp__9>vPRy|9h*msu7@aR@f zcyGxN{kJD@w{!E<{pXT#+dwJLe&7Rv`5Zwy>i!g*Ti?fj(xqUHE^mwk>ORWKe4rrc z)`Y#EsL8cU$&Lu>dsNLs(nqUN1n>v={011o6Ng8WYbLp;s+%{Yo@IP#345l${5}dy zF2&9tp24C81ilfZPNq?A94H1Q5}3;F9N)SYNk$KD>F}; zUGYx{iWpz&#YQ|TJe{fq)aH8Vp23NeBKG?KM7bebqh?FWP52vqG|tztMn&RU~< z#Lg&xDSsm{Z`bc#q*5`@&Xq>#0GY!qZB}5`v;(?oGJaDD&x2eHKOIE~@m%Q!+i(Q$ zk1WldXy3u?Z6q&8PvJRTfSIXX#n64{K};FH^uZ6gU}fuPS82CQB6ALTwR-P4u~LKc zZifno(W;I$lA{w^#}>?z1YA(6&p+JR*Cs80Ecr7t5uyxv3CTD4+v z8%aDyepa_u`i^7L-^&H=bkyq)Ci4ac=^1a` zhsSB{3UsmeeR-mxe{|(^IASRQu{6Kztc0}tqEL{A1k}RhvGH1kya03hLuLo95yg?w zU3U9f-eY2Nw8*uQV4UH?qo@apM+wp0ccp<_#SjQbMihU3i1Z*`JVtP~&Qaikx!%3t zpb%NjKQ!~BaCTQ*T|+DAv(~G6#TJsKGJVy@8Y!2oT-R#C%Nog`!P_(Bh;ZnXq;dW- zeW23Z$~=GaT>riOl1e=-e;+ANFmc*@d2v1PQ*}#E zp6kx5Jn!CVzFK9YadjoTdpJ7!bWn#KFHV`}AjQ>`mpiB?7mNE+N(cgWy?agloKD1J z1A}WK>$We-TSxv}U{SA}Bo4JSGs!RWwFGyDK2;jLHN7Mir?I zReu5D_FLNTqR_=Dg&Ze}=0$?facxh{9}V=paZ|j`1a#)!{6RtmmOcM1h)l(g}oChsS zKm=zdb^C*ZUQ5$UvCTRQMdb=FIYai!iSLVQkM5X>S?=EhLiSSw({~-SUZrAgHuy6s zCItLH?7e4LQ`^@s8Wjt=Rf?6Wbd@4oK|lcuf{2KK^roP+5Lyg90hO(wKm-I7kSK_N zKtfCCMMXl7AP@{yx(NXRLkIzKW)%1P?(_aX+zr+@HYt1?4n4{0%Xnipb zB4TxL9)0+Got>#LWV0@+LU+YBX)-))n{`hxl4sUB5<#0^7BbyHQd_j8&g*6COZxP) zENOyg?URpt6GE;czI0#eEqepf-5QBwKIsXP%d80NKu|Zu|8Yr_nUxske``cMimJHq zX0eoJP5M@`{puZjjCVc6Y?HO=#68=aug_X2>TNa=i!Cs&eIT*sKt6cx>XwM%t9D|( z*F3ux8q*Xmf#?N@2XckJ)6uU52gkL{XO-a0!jRnu5h5VlK}hvxT_I0iGCh|}_WeDx zd=McL;mP07S%J=h1gv(kJ1uf`3JMjyd^^t?isaz<9h{6yce5hXVAN(4puVda&H9c>EvcQGIxasc7r-LAC)hDclj1Sh&Qyc$&)@?o zFS_=rs=s@Mzs(?VR!G`?defEI&tp1?YQ&|`l8f?eb}fgEq08d-)5hQtn8`TD#40}k zdmKur`O{zXy-Dx{0Y@({Ar*7=Ay};0wO2!m!sA+r_oq5A)OiKk$1+oPw+Y9+C2`q; zHVLb8cUtRIEhL$bOcF5pPX1=ZWCh|A!{|!-fr*B8N@Ag>;v9$4U?ZN8_Xu1^9Z> zu!V_yonxa*tFxh;;@j%agpCTa`&8%lO8M-H{q9pgE2#c*Kk<6fDIZ0jL45vOOEH)L zd*|G@nci7j6NAA}K@J+e3Th)b^WVM`Fco&eZB@t`l<|B~9>Hb07EovuO@`8XbW($C z=PF&-!h;9M`*6U0rtg`2j)SHGEQ%WfuWxV#Ph$VrNkY_F`*jVEdMJa&p9 zMBip4cP-@f)My-yDXj7A`l#YIDKPsy6W%mINk>+jO&_aYqY=JO&;04-9{K^xNX6z3 z>sZjX>HTp{rNHdIt@xT*t)c4Wm&eA6_8hkq=o>$)tEf=+)L@_{@=$}xmw6RA6}9UI zEA!^1flqt=kMW1+v@j!HUX{veO>mtprzM~>HhaFgJneM!+=#R^)^1Sms(nu8W`nGD zpQ9U`+^cO9DUQuhX^#?}7nuT+)}=cP=wB$Pw=e92P-tM=o&mv~Sns6?uVvU<;~6Iw z?OI|3Gf2Go-Sor(E5EZ+IMW}H%;bNAwNW%6k4k3_?nrUXDj$kZmlq|Pq!4Ioj7m}(d&JoN?68Wc zvN)tYQylIREU4<9Uf-p`|H+-fXxeYOq1duEA@h*Su14Kqd8HP8@j3XwqI`MY=7UK( zr^o%CA2oRQ-qz896}hRrel`Tr7oxy?8U#y<(cYMDI;qCE6PCkpw{m|>RS{H0F@Pf} zU!IeAN%bwgR~~=P<3#sW5Le|Nr|r`&g~KL$tX1r%Wx)K457rIJutY47ZRQj0nK``f z_$$%Ry=DEMpTgJPCI?+5n|Y__BEluNWD5;%pW7>E1LWb;vlflx(xLsB%RLdCQX{l( z&fV||^b;}*%~?YGpG#Z>h?$(sL#Dg>FNVF*jFcqnSy71WULiGG)BATiVtf<}IU)g% z{GKoKzy@nJS5sBoq!%rib8#m3uN&}g@%aP3Asbj3F9&&<_8-BNBJk0U-VUlYt^e9kdp zle<=r$0#*aSv!>OoIUM#YBpFYYV4lv2)-{~nc6FS8)~DNKoNuT3d36#wB}9C(#L|` zG#@T6f8{R!g%YD0|59iXLoJbV65G_zhSN0XF8x-|AUmTTrm|n{aqvQysp>od{;nm5 z{-$gA#v1a_R*|H%PVd*3J~d`44!zwHmVu60*gTSMva* zm54D&XSmzcXAO>~QrAkim^d7}DJd&*F_IiJmi~mKj7nR!D^2rKWN3Z{6Zg^q?!_RR z#mO&`RWC6iKBbtmG!eQS_e8AA)1dw@*7rWx=CFD33L|BNMVyArq(C1@0S7Dc(}FW! zyaCBBbv!(0lK(aqwy<&v>tf4Uv~QtbM~lyl{Ztv#|4@VXZM9Kzm|DmxqINLVc%$9n zq@_D9JUbG*=}sgRtY|G`x7#gB)$g?-lOvb)`g5tkTsW1Ko1;cwt@) z!c5Tssm&z!)V{aoG>;npSg1HN%gio3joxWWyf*t6BCt0uq&Lmh80~Xe44!2Vx&?+t z3m{lQT~5(XkDXGNUmR-a4N-b=xg>j@k%PlaVK@{7W?3}5dA4{Fe)X+e&m#OmYy(Gf zVpCoD52qRVt<57^Ls~iF6sNB?z!F)s0w&7Np6)PIe2eWN1$nyC*3Uing7uoteUL-2 z%=zVE(v+&T!T9?f{7+Ne$+i;TEt#>nV5D`^Q(J0L{=AC&7jFC+3ZGUl4Ys==l*?jUUs|uf%W^jd!)-K?{A?$D>$}2gQwzsngH1P$Xx+f zHlxq;H2CJUNE*LRD1WKH>yV+QYKXyEIoYHun+*pov>s@_OO@a1I6*ma@3_Ic)fHlL z`C_Zl$>%m%fo@NZ=3@9_XjbUTxB9$@z~WQ?KYF^ki(^c1<_|n94 zp}g)!@$FEk`}+o4h(gPxB`z>=(=+H@tT(XOcJ(UY5o<#CGMPS&^zw1RFSu`+g4!{k z1ypO;4^dytGx~|XIZik6h=DT`uxg93`VaWE(=IKRDQpz-MZQxbrTRF!+LTu`SX1Ms z(+o4bx`*~w3Bw}ys zl)LEHhz&>Yag8L0+HSeK*e3=&m6EQ%2&KadikQAR_Tn%5Xq^zXASQ!l3a8<&rZl-q59-T z79#4o5H!7uoZaFiA47h$@aT4jUvON#*oy+=(EVQ|>`%o6V?}!!`U}RFuNyQaSgmS; zVI|IRG7h?}Xgg{_QVoES>c{%yM*h(b9o{Ekv z+rUb)0nY!m9@q%7TjZrTb`i2$k`h&d?|mrmx@|)btS*>rItXl}NC!y(102ZhG2T|` z^ej&Bbk88MTr(-|Y}&;d&vFt-X`-9TZS#t{$ol zO&WxP;v0h6Y4E6?P*`^CJZeen`#$g?+M!FOGc@kjTV^NUOv6^bsn-? zzc{fVwsu7FGV=0!>ub_m3l^VNPgcrob+#AKv4UpFZ}o8Z_BOcYc4W!|_GKtp6Gt8^ zQYovrJ;Ys!(LPfus;EDWv5bCmH92q>m+eFCw?{m*Ojk(w?c<=T4&i zC2|L|4<+*?cSjR$O|S>fOJsYlGm5gWbS zvYfx+2|Njj_fXx5tNC9Rf(#W6HdFu>UtCS*73NpVoBg1U&<4d?_I+~9LXjw36UqvC zucLDb!=CP0OAr(xcml5un$*x)HO=p2*dISqHG=RpxvgkZ6E}(nkfg!7k;r&vq`jqXoVc{Ti#rdi8lhy_NV z&ijUrRT`4O8%*pknB-NpK|>8j>dgVOgs(h}mh%}btPNRwbaj z*4vlOY!*wMNi-E3!DI7t-D3$yY?zf&Nfmh-66GTiNU_Y{+?if)!Wk0e`zaF=h@AYs z>oyIP%)*nhTAr&%lQc)t_RuXcHOl_lPVDX`+tb&cg0e?0(?FH56R75^V zkF`cDY`7r~)Ma1tA-;3D=8HTe0?+PJ8Jn>%7_xsYZFtnAZVowaGC^~}}Kqf<$n z+W32MEenhJS2RCzNA^W1e4v6W+?1yE^BQl{nf03N7saP;N@Cbuh|oyMMRhI;DnXtT zs(4cpEf@?$^L*y*wm~M_p!6qov&6@WewZDy5s)PW0XvCcFGhq%B9&ff_rLqk8@@{F zNt~ekn~f4TTjJFuh6UM=jA#v{Lfkgb`dWj?9fw0RF9V>nway}@*(M!0u6v`WPo7F| zk&0Y`wwXP-?;mtlmotkuDN3y>+QSEJzuMa?xTl}8Rode_g=>L^i7~FT+cPDVKWzyIcivQs&Z4Ab# zc8)SP+poEKX5v2!277@^P3N8popJYlB6-;^?Y<1$sKYWI?WEYtj}tuiynGz}1noo> zZ0DD1d6z5X(F9W=r>WmKwf7d~AH-G}R^59e&&cb`yqFf)d}GXyw)6VIp`LC|yuwuk zU>U04^umUA`#9zg)dEQOvC(G+Vo;}d*R_ZK?7>E72If8QBLa(q@c4CI=G-0VdAk6> zFR5}G2+SW)W~X}#Bgb8!t&3Gk>u9FTo)b{Dcm7*Q05I+ib8^skU#s7JD8o$}o#aq0 zYNY^>4IV#=9f8rIrCsc+J_&l#4jyG`q67`a^%5Z_%K zjw^Nvg)UZs?ip@Ui(TV~W#{EJRbFu|e2VM@Dv28&s$|xu_NUqO)K&m}8LqGjr5}3< z%U210HtgQNWv%5uv%1c`b37XpyKY?A^;R$P<>juA zL33U_;Z$;Jms8{2glz&JUu$kW(%t!4b%Zfbt1l#sMywLG$oGQK*ZL&evqXcdoOdh0?M=vS`b9(?r$ z6a*FWm$hh#wjrBk-+M)n>>CKHjOnZu@;6>%g1nLkxo(L z>UUp8Uo7upTbcGCo~8Y5i%1@;zu;M^9vEU$w@pY;aTc@v*Gf z5>*(pFrYff6Tx0yYn{!=8ODXdhE@}YEOvm%yU3o$IGM;gOTi6QOQMIis*yMP zz1osRn?IsnCnRkzyC{h9jXC6}^`KnVqU%;QENCb)3KV1b#Mr!9ynjcp#`bC$t-)=Y59vO z0n=Y!Dc@+4eNzx;M${;a|EC9Wz$Z-T$R~X1mCYxp%rBDy=bi}VVf)BZf8pacDOv5h zrI3&l)+pKia^QNT-*fgJ7>^I3glKzOXO*G>Jy+`i_7lt+$FhFD-Tpy7%-Eqea=AKl z#;Jui`6oGzRUw~{16|Bs4B088PjY+Bw(RY!O?T+34=Z2{b~M|H@1BK=poJ<+(@6bg z<#&v5w`bIf6^N#xrM;*9j6{iD)nziQ@mq0naF~$0K;!l2?w@-VWvyBhEM1NsK^U;d zi|*`l5q4V<_tAn(XMivrD8kIwfxucc)wYr*Hl~>pL|Q1yI!|EvI%kWwh>0JGQQ8Wf zyqxL<3@BeQ(+yoRKsQias~J+ zco&hDMCQkS1oC>YeRl>|Kb8OKFM3`PVO88yy9nxHfm)SlOQVZ0U6{ z7+m8AT?B}9bBS`$acO4we@f2ncjyW#*_~H5=SUnE(C6iU)|}}n?D#@qL$vvudnaJp zDv-~Yd92%m=FhT!%v_HgO)=Bj40an}oi`Ix#z+4W!8!mo_=F`WKBIzx2;;GIb1vGwbCL4#C8k^2Oxkf!EdI zj)AbOOw||GwTVGWts^Q~gZo`-wMi#C|I4r?@HA7hqG<#;_Y~L&;>|s0y6LD5YHP%e znJ%sL`tsJzH^Hi$0QKJ5%0rh=Csi1#_=^=Hr-O48xSI$c=Bwflv(BMcoH|s!Cmem7 zCCDt7xBD#gdccH=54`?fHv*~(porY$;bcZEJ@6v>O0O$BxCyZhNTW7u4kcLADHI`Y zCE^t|Y3g+K7$QX`W;SoljLA>vf9Re=9BKx2;=rM&A2*{~Zt(a1XBb3s*EPv46=JV6 zozL9c0p;bj;^~*X!GAZZw?^~mna9g3IYXAUGqNp2fpg!>AzwNug{7mqq{F9sNw3d~lWH)-xJzLrKwn4Vi!FLutY%?vp$j=UH(h_@> zW?)w%LkJuq1ngraH`H2qK3=XVn=iMuDnSMt4XkRMG38KbKOL=GNtdD`;b=m3x>npc zH<*AL{xWcT@D5&$A-J9bjM&uGco$oIaTtVnj2fL;f)&A=jOti3Cj+YlnOu;QQO++@ z5LB+EIeLC+PRw#1%kpm3MDnC{{}1KFduO%uQibd7Z^k2s<4(_y);q9Gi|Q(3H~O84 zVRNxse%t4NK)j9SZY7wH(7dVh@)NIEG*7B;fFB4^+bLXKt^bv-J3a!D{=^sph0-;H zuM;j&BJ`3h=I}>Y--Mt|qICy!xA)Ge&2aHh{w5owPV-~`pX=YoY3I~{E~pqyJ12$m zO=%tfX|%RdPSZy?pu_3RHz99+$<5ONBLDlWYa|Xj8L`00pohuv@2&oaQGfYm?tX`8 zfk@%lD1M{P2%J{a8hvPuPOn{~)z$=4bO-hwNNVbU`-+3owZ9e72FMJ36s?U)T1R1B zqQ*}@6h{THK}lcr&mYZ<{13swQxR5q;K&W)Xc@P>NQk4Cx*Nit`q|9(Ka6Te+2j92 zc1Qs?f%s1+@81Xi?eG3eihoJ*?*{o9Lg6A%{Y#4f|Bzzl&$AmK5Y2@RWm>CTsNw%D zY}$W2Y$F5`G_lDWxy)^EUi43&p{xb683Osyx^;N@$4|hlf2wNlqz&64kg4ap>loku zgGTzQxM>dr^67+l80|9}j3V)WvqJ2)$Uz`4U9=$NEb&bch;StN zS(R_w)^DWhrv@DWX~<6g^&4vOYK-H+T7NCMe#2YFhkEnQ-qe2w@-IdH6OYuf+23&> zbv@_sVXN2B%1(b~?HX~bSLmw2(l9+Kl>H7A9gBv1U+fD7e{-1V@9+A=*S_5^)kbaL zjAw=3-95O*D&>gcs&h4JC%A>X?xL^Oe7<6}RdHJ6i}{ON;cx0Lpbtd^#oU}$+3C`sg;g)sLR z+2n}xjiiA}?`iF`jmYlZd*McNB@IHgf5n6JZ}yt;*O@hv*RsAU(^QsxP4-JaT08Gk zSELGauaR@EpvO#3dm;CY!{;l&cKvn5besMD=$(iCz3IZ75PN^$7Rk;1{c+gR4(Quo z7m<4O_eV8zi}mdbsVn^V(GbZ0XW!sxkUH=dJ^e{C7zKqyJyNr2j7CFJbln z@iJBw0dxmKZe==vVVk1wcL-6YwWXYz?aApAJtA&eg|gfAYZ%^f*o^_VjZw?rvP!uy znWfX0QLGk+n$^#kwUVQ8vQ&az6Y&QZu*&8izbFp@xK;!6xxL8+KF;&u;X8jl?gpRT z=I_n!tgjEn6FWsJTaGwmIh`~%yur^DRu^&*rxV)IR;Aob#e%t_j0g5 zhH7s~CTX$r`iumLOaSgt9ZdHV@wsBq_v;;yD^o{r^so~vwBO_>1W+3G)=1n2;7V)m zPcJ>lZW*cyTqu4Wb0pT)xO4}AdKIrkkaYxf2aF<|a%s+U)&@<#?HhfI4aI|{U8~A4 zD2toqgy|K50>-p^V5qVdW4B}TjN^|;yp!z7Z8~6TG?`8FP);a_1;=RurD9%*>J6&e z&rabG>+?=K|M$a;xFmjnq%;5^za@>>a>h>z>+{__dRS7{qNKvA!>9)16>Zv|M}ZEiJbP?{@=Hm;Ev z?*N!CW>SSDOYPI#3KHtvL|Y0*^uja^$=vbl2mP19W1r3$NO^<+ZXCb|@8q5v0&7TC zK(Fc`ueLrjEzRdH41~<+)1ckQwr;&{$8-^k`QpN$4h(V`v=cZ9Cz8I z&X+K1SQ9B2g~zg1W49t^YdLFn=XDa3$VdxrK9E;3wuGPf9DP`6sMz7xaE1vL+n+IN zGH1|k!7W_0I{(O>2yGk;JngFA(#irUlrYUj`JFDBm;(9qlLACRhe#80VAJpM*wB8D zhkj(PT!pncGg z36ofYp9cpTt5*RkQ6*hB9uzg{ABt`KR8M}XV`s0$Fp~^?aVfP?U$~HSX{nK>bH1UI z{9(*#d5t|gL@$1XY=sHp_Hw*hMgk-vCB-kK+DuEv=~HPx%|!@g#o_PQWX^MA^Q+%K z?5>3AJ{1&A)G7L4>-%966FQiWi9ad9lGNTHc}25Lvc-t;On`SkBIVLdBdwk`xmrIr z`8t}9XvSQB==adS=M5yn=H||LN!^mCVAXfhdH0(-AmT1|He8Rpc;<@)VJGXDevbf{ zl2{?iu)r16FH%$y1HF2cias^!g%{p~UwT7*1%G{SSQD|g?if@$?d==@x%F#V-zsHQ|0N=WWap@BI1*v0AG}>}V7Ev% zVEr$p7zV;(|EW@vHfP1omTIjh6;pGWD?oC*iOi(C}-G0DuLV@Pq!TaJX$nAX;c zkXy0GO)+_gZ~ofO0e*9b`*Q-!q&&J1Uv;>~fyB)W*7EG~xP^%qY7Tx&NjLp0l5*k9 z-3(9d^kcFf*L{%S1oF>|B%k&&cGP6<+{nJ#N1?by9Yh*X5miOtd?;!ui>3vW99oeu z&KUeY^59v#I`(_x5zsI2=SAkCb*)N^325utg*;Is7GU`@Mvefvk}D%HZ3d(w#q%)G zN#xpTvZ$5Ri4tME>?R?@HS3sTXKqW@nCq-dj=H6hV@B5UQd+L5f+yx5-m#I`nwkep z50%IpIA9la`?b`p<~f93XUXgbRVu)~@*0$e)$fEK3097i9C1F#D_Dq%;E<&6os8uX zFq+>68wkh;#{_3(A2a$0hh1(E7Mfd9jI>y)f!nXNL^Fc!yw{!fGVr~KdeqRbJVA(nzim18o14D7b15#kd7a|*8U;Z7yoGUPkBPEACx6?@ z!`;AE&Xw7EJPiN^{K#0NR6j`E_Pw+I!6jAKzFGa=Y#hEMFR(2<8c*HU7p!AGxr0`6*Xk*rcs4jiN)XnC=ddMT&!Mc_ccpjhN-E)j?=Q|N#c=d859LsPi-SIc^ohvpzd)u_prF-!}?x?B& zKtAbnU?XSsr7XwB?p_+s?i&lgYkcn<%DUc_^CVt;WYW4e?uL)dUB}F7gLV;IWY*IX zq!wzWxBFqY)N=rE@!tpRwm#sup=*;V4{Jj@X8qB=8_z}P{I!%E!^gW#{gu;G4}M<$ zK+dJ>5x6sM4jBR*FGTDmV?nL=m+yUi&hu!+OsUWzRnM$8Q934tHhRq7TDZf0AoPcs zjLHU?n1Kd~vGADVLXXSDSZaYQ>2wO(z-gT|&RBCv=CeM6qRzsYDt!kbXS16sfKIwqDijBh!5>}%a z4r}78lEV+g`jun2z7R0(%&>1dK(o!5U;A4Bo?L&W2VmcA)aNCf->O zXnOFy1E{8}i%DT_JVv8Kvo-9QuPI(N-w4$%T({@L!`pv zgjU{`A5NG{8@KV7;TZi7%T(zae?hAz>Z@v5UPMeET5)lrVhsH_@0*AEXJN+XTlk(YxPD1xfKju&hzt;OBbujZ4i<8)VoTX?qd3a0`i1e?CTEW_JJ zpxdm^o@lKZk!T)0vV(sGcX!@ZviXC&oDjPd=B$6%P|7A`Woa&H^kSH1J*m(^(@zkQ zzxt$hQ4-aTNLo&2^KTgHf7t8N^DrbvS?1M?3#mqZiWJxJq=pgYba7U)7~_<-g5z1q_KbRntfw>+IJIvQyJYN+1+#Jn*sWJCFt> zKD~rp?PbsaROr>EYzh6Fd#<%l9ys@fk|o#Tl+XgTF^UzGSJYIO#7s`5 zp1=Ckb;ESX3o1GP7V8YuE}nR#R7EIvuS%o+qzg|cJpHmC9U42n5LGTfd`sM2I3U*~ zLBhRl8!vmn=%)s>5^|9Tq_=h5dTBLsPVI6cn9A|s=xlcZqt6ZBvv-#(=`n*#R8mHZ zq0i8#s7|7NSyhYgPW;Vu_e8FQOj|tc3Jb{J4K(wd{yf2uCq6@)pATkqzVU7gg`6x> z=-5S`a`DV%NOrySH1uwqJkUolB2E(0>2fXO#d869C-l|SUuy2yGP&S+cS0mPjlQ3v z`l?5T1i%J}kD(oDH?A=;ny7fKJ1FmVyxLRl zAh_eaSaHzqTk40$TFb)|g41OT>gOl{4S^-W`Q2n6*VXJvk%hn?$tNzS=O7zL0y1tz zUnAmcuBHak@4I|j_Zqx6t6y8{J$qwk1bNx}$W6&mm6qwxtHwR|`cxpc<61A&ajA8n z`gs(DD}=6-CZD07-zTtmcd7H)pcnS2N1Uk?Gt?Zic8I@b9f*2FoC;EfrCg&WTfJ|% zH0XCyPuKn4dE_JAofL8DmuD_&HMqvq1~X?)>F>g0%&KRtB`*KaUWECkpVK58zrUC! zn8Aw2t!CGFo=CQk%!MDVUyUQW-@*0VdSv{*Au~L)UpLAoALknk8#<5?Wa#UFTcvCj z{w=X=&s`O=+?i*t;%!U&kQpAm&AfE^l0**U%jLRxWnSTOwBEZfBK2+O7*(OW!Y6CS z!o&O9LG7Z6?1X!4b4cSYG>moFR_CdQCMa$lOxVEM{Ji42$S!zs7Z=Mu| z(@i=J%NC*H9{)viW?Vt6_HD6u!`(MlTHSAGw47sS)Vb}FpX3P(iBVTui4#x^?T{k&nX8imkAUXY7*T)h6wcy)?W3fH_G zp4~3xk%vk!P0IiwzM9dt5jV{5+WkCKN8v_a~Hd~m9E#ayg7 zL%r75zPls-MA4a3dQ79Me`XWg5gAAqFoZF3env1u?xrO9Bgt4huJrWfv9~ZW#<9wO zQbNVmie{0=6JxP)g#T&Y-Ik+N=rCdoELiTlo?xTiMtVC|4}NEL!9pec0Q)EzU4uPL zCRYG6(Q91!v=BOB;jMX}{qqY7EXlPtvKA>P!|6JADdNw^%yffgFe@%RfVV>Xk0s-f z1^*?D#_FasjnE|UUJ_4zM)j0INORQ|g_H~&+!a;=gG#(_odhd{PO2@sJvODk*<}+Y z0~$wz+JSa{rSs23qlwLdX1OpNm?dmJ#B1^(rw19+4=6Qr-*qyMqKmjwwU-<~zrXWu zeKUOJ$;pj>Wn{^LS7HSC&_)=c+@^WfxDR7WTwZvhlL6Sx~z28Nknv3Sr>;)iYvHrf8CA*Jr*eodOEATG!#`KjRcs##5auINXF(l~LKDk-|B;>uA{2;a0I9`idW5`p1CbZB= z?LI1zFF_YvT(TW*+8z+T?4dO#Kh+{ZaC=PLp80r-7=hiCctvZ+Yo4KgF(KHtZo=66gsg1Ty~08xo)YxE zM)hp1%exxI;tL9stKv4zs>=l%fz3_7lzve2w&d1g+JW(~CFA3jTjFTX#tVfsd0)vy zcdh0oyng5|UHG+JP}SK8)3||S<&Xk6$Ja#Xhs#MNs*1YMd!$4s)+g^*(rtmp|0J0qK!2WOai@b4Tm#yyiLPYaCicevo(u;S6Ci8uqp=EkP8hZ{~coTw*s;1Z;s%P@~ou;i0nb?nQIAKAI2KZOy))RXAxjEG5A?C&7>#s zqUrh84wJesKCtYgF|>XmMvm5DnThK)L$sBAUd2Mg8K;{4Bg z6=i@t9dzDcI{1#L;~&1roy``<7E01cn!w8p6thb)zNW?WF@t5`;dcy^jm34{)Ah?v zx`@FQl`VXQlP3IITM}gL^ZI9R{@{rU*^N68{Vj&9RaW#j6F)vXEVm?-9wPnBeiND= zKYMJ$T(8W=WPEhLInO0pR=3#dRoJ}bqe%IqWagXT|&r7Lc zb*#DIai(s_YzO$9?MRu=%9P&9O7B8BzU+Zf`5W@5hCi#id_o>27j!g_R`mPY&d+%v zFq+-?33JpyU^9(u+TQ{dm-_wiy2r`}y^u2afBg*%&VX0HB~RFX5P|-F{?EKm)`yoI$)?5KulG?lla!}Z5 zpny*;GI7gAq;palAxq!Co*FT<9`MZKwreCi0n-GVi(!2Oy@moW>>okrSpRy<(YTY8 zAg4UDo@E0^4x!zO7EtX-uV{N5%pSg(*H)^|0jC7~7?mK;v%6O8RDWOD_1GJ}6G9UK z22now;`rd)rPgZKNpU9=+ORIyuM=A%r92E>V*n2lHAJqy6l+2J$d${gCtTg^t=x4Y`%A??Zc(nbQi-*&S_@OHmg1uP)jFD(&4@VEVRA#!pt?UQy;tT)Sm}ou+WeWFSf~8-lu?! zXM%^)77XwH9#$GisTuv@$|h^r0|khAxblh|k>9o4;iuwhjLGAVJY+oB{2t!mJo6ER zOxiBY7;_&T`8!@v8`|x~5g3b_4G`pW_^W9C!RSDxe{EIaHpWgpL9de()j}lpF~P>J zF|@IsRE|AZ9V-g@$@#^;6Pnzo%jTLxbp)Et zG7r(_+M41gdcnpfX7nQ|UkUKSfOE+k5m-IPMp(HWQ62ckE<>YKv2Csbr6~;1u3$Fo zlySuLltKP(J>(9J zd0lJ^PD$NLa*P}kij;fo5SK5HI@g0tULg{vlWw6Fj4{cvLocyHj4T=%m0YqP^WbFS0YV!oMhA=+b*x z?fJQ}|#oeHx5&>?shSg7ekc&+-iVpjK}@C(v3V>ynp%i||GMAoB3&pFHR+F8wJ zFH~Pj-%4-J@n9!7npZgAXiiswkWb9^is6c#VSLVp?@Q`E-4xl3g&>OjA=Dn%)0b1T z>0{v!w=I1{8SkS71lCp%ddJp408AubA*N*Qq0qJb83kZU!^KF8dlC$gjSM_iJsx;` zXjE#s48l--F;dmB@7ksh#rSU^vcZm-Sjyi0YEdPZdF}JWH-JZ$o*&ZQF{D;{4aby| z)1pFGYNK6Nw9(z5>r>gCT6Dv_ko$_1_Th{sxW|urbeT*BIkA6c%G%x(Mb~(g(#0<9 zA+jb>qzRW5Taw#i@JJkGYj57MupEHZXbwXcYIy3cv4>_jZo;hHn3V~Q+E)jveYUZZ zzD>80G94z+1FDrj3~JXpP8x8FUm;=SLtDM|jI0|myBzF{T4<3lO~vMsN%`6MO=TH~ zY9Uu_(*{OaA#C6cc4v>%^b@oN&99l3OLuEF3pN4PN!#V2g=geB>^YX@Wd1^yeLO`M z9CBt0k&ojH_0rF4>Uv7Hmu~5%^}i)%yKmGr&~f8cZu3yk9MeMITRM@n{G14X`r{h$ zZH&L@V>@19NtQn4N}>m5m3>E=IxNS_m8qt{ zwz^m&lQg2G@-?^TL-d`^$Iaq5x4)$;n-l4AOOKv%meRc@?Z;aCZPPe%DXRk2#PH~4 z=i;Wxz#nf8a@XJfaR#C&L8VlF>v1OqPw7L*JxgA`5U)L-s(L{tShT5k7q7pplZSfM{BOiMsmH%-iSqXgAdp3Nty@+ zR*?AwCx7GkF|tMr`K8R)a1ABhKHCq*aaY7ztVX)7Xw?=k(3BOW(`=JNk14+hGIYlA zG6G2IyT9JULf*Ki*ID5;8>nUZ%WMmzO{w3H7FF#A_eE!hG&rX$8`(Pe^k?XhL%LiS zOjxB-1~VDN1bWQIZbN&b$YyC=zUZ;8iWl<_zv~)_TNZXQGn5^6mQCP?g}UtRWZN8S=D>tysyRjbws$4XY7n`RIZR3l@ z^lCjEOx`z8g@2AXz)&Jg_%1boqMMhZqCQn#l$LmZNzZ7;mAbWIzA(4ys@45xdQF?! znl&cYSHSS-HXl*RY)TC_BgO&0J{2)oX~or4j4$70S*IU9`Pp?Mp$8YxDukGE$eSbw zXEfbiIO7~BAG5rwF6|-GMuH}PG)nVbNm!^PSlu%~{i$1jgNi~7m5I};Jm#N?RByqQ z`+q%%;PTO?GHuW`E~#`CUzxDdauPMypfn&~`}M%8fF0|C3!{zk1$N?BEZO@i&nC%; zL^8z1yytWKmLt$Zfo3}$u_FGrMHiBNL!kqnKKY7vpAQsk#DKkmZU|8sw#J2GZR}*z zkP08&#orrT?zNP@>7=ENbNf*dhjA5P-W-^W;|}tR#gY8}hw7@u)F~BUdh8%&bGNz3 z`Zmv9o9pJr*0El*=2YQU16{8~U9U@T6C9}MFRJmsG&{`^b{v;;@rH5_sYv99gO$-~ zVX3yen35ZsxJ8?UHM!lW^!?=^gDJ_nzdK6(>6N7)bba53G-@0TrSevcnfW}zFnin=LUNR#|-YfH>O%k7&h8^RR&NvSYMo#?gRPt7N6?D;Bzvd7`8q6e#$TI zrc2~Vk@K;FM7&4e_;5g)jmp8-8X8H{=Dfmzm;{{ATXQxtpFNjn-1#9kM6p=vUN?04 zI>Sw9j{*|NB&G(n@I7mY z3G2VV^1^R+sCJf`l4zwKbU!vUl1M@f6)aCIPZI#<4tFM&N%uX986^X}!iRC1?Qxsl z8xJ)5NPDb=vUnjGkiZ$X{Ed*4q2`;gg)*8nB2~l3eiTbaAUyLuOOuzp$CRO6fvHq= z^Nh90*Y~dBECk;z652Wtm4qaayQUV-S1Z$oViOkn4iA;`)0)WRa>jDRh?tQpH&1Hk zc9VApINNQw(tYc0v3qb-w~ugSmir3*XRc}OW9U;>z*87zNS^RV=Lxn&u2=nfnzBG~ z>t2_4WmOY|qBQeONq7{{NH-Vn7Ffcg)^yn!K+cTT08ClS$!MBi$zaN+bTEyYnT*1> zkvo7nz|L6iY3NvK251;FXSUl;^4#z6G1u~VHaX-fUlcTmM}2ha$)=f#=sNK`=4(;) znD81sXCs3~r@7R-^GRt1#+dm|6xJx(3h#@mEb)09*fm31D)menXKNB(Fw`5qbwW+c z%trWZKXF-0Xnjqnm{8=xcd%zs%-3rIKpG?AsWf*#&z19N!f29jm2wnkQhQBN`sNtw zBZ?K=mfRt1^=l7<*%mvADsKHEabq7Xh>?53(NID5O8v5feQ9nV8ByI)VONrb@#bUW z86Wx1P4&;neXkKnMb3ac!;j;C?(onuw=M0kBtW@sU(f>5=YQmPm#*pcv4TYMi4!V= z`<9|dOH@ZDt2lDJhjIF)qj=TxKaOB%uF>y1GtedCg zJvM@KjaWQmK?G^=h12cjGOFXy&W7{>7Z|51ruNu1F=FmyO1#KOzdLg0_sNB4(adJ( zdwf?ROc!TnRfTFOvnY=~kYekf)0WjN{s}fB)J1}&27#Swe5pAiaZPVnpav|D(`VoIg(NHF30P7@!}RJ!}4&gmH5HiU&L1L zej0;|tsed<&~X=cIzL)=NIQfpcXpHoPQt}szeXyJ^P#P?7)d0mH$Cm{F#vSNl@-~W8`4E(g7Gwq|^ z=y4Nby3l}sw+9N_@71w5Z3_Z3t5ifT+u_5M%6MFmR=KC&0D59_R|YibTbavDw=+Nl zaNlV6EZS#4Np_`Gr%z>rimt*A;pXf#D-+ zQ~agX*!^IS$D9xvGC(5V8qji+8jA7C)LNx(D))pyO22#gjJH z`6!mxA~+OI-Xbe5gOF^A*52+ZZkMurCr*B-^hAbo)FS0GpY<1PeHaNqWB;I-mFDOw zCm8tICCQUw69TTPR*+IIy?-?F($_JsKW{oI_S2u9`RC90?+A`%EJ*&jQmX#< z^?hJF7~&QKCk`Yx1JAaf|7Xh7iXgYO?cr-c^QMzb|NXpf&R<`7`#N~+`arfS@CsVB zcx`^LA+W?Z9b5q%$OhH~acvcg+-y7-|NQdu@_PU47QerGewg_hI(hiuoyU!a>5BEN zUc#Qz@9*t>y{$ET9dwGWVYjg31CLD{^7eIaUWL0{a?d^-ZhSy4|Ng$eU+uVoCHD6e zUI~~%3=D`FSE`M5fPxzcMok_}15l7S8I6=dH7Yn7DbNrY%_)Re#0;nM+3c6RYXgTe~DWM4f6Bv$R literal 0 HcmV?d00001 diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/custom-sandbox.png b/apps/web/src/app/(docs)/mintlify-docs/images/custom-sandbox.png new file mode 100644 index 0000000000000000000000000000000000000000..20f4f331a2ca7d045cdf5d14bb890b32ab8c8d03 GIT binary patch literal 39794 zcmeFZcT`jD*DZ>IfFdtV0jYwhC{2`J1q7rEN(+Q4CG-}06$GU!(xfU7Is_yH2pxo| z^n@lIB7}raq=k|b-rqUjxOd!f|2u!2G0rze7=*o(z4!C%z1Es@&H3>Dg}x^JHI8c( z6cqGY&z~7lP*BxUP+az>r6zANcp73!{&m&sxw$U|1s%)9&n1fNTz2xtOTI>$suVRt zTsZO{R8A^-DijoTDRif{S12fQXtbWGyb8RuaTZZ^cRUOm!gd}N;ZI5JYS)Qg)O^e| z%FdYl%uS&4r~0k_e;#%5G^WbWZ7RP@RnFhi|Bzq#J&Ia>w2k@mR`|Ksz0*s7!|uJ2 zN#x+M(ESdcy=_bL;K2R4#E+vCQ1F}0*Q#iVO?LbHN{6lMe*@}=E)u~R^+%`x&n zdyB1}bpB_P5%iYLf4)#YdA;^OUl?c&LR!v=D~m zD|JMhi?iWvA%`Z=);;ZY3E{)l9M77Xrsa72FCl2vkmBJi(c4NhX!WyG#r=ZNZ^6s& z@5c_&O3s2x;RM)~r^ju2-G&}aJ^Q2xtD|;Zd*RIZNqLEA1=QW5m zL(GOVvpMvm{GQKt2kCqw$jE>(N7l7)9VIu+VVYJH zRZ;~&qr$q=j&)|joRBIfI$;2fZcj3|eEj<3YF0B~rgYM`ki#tqs1V%i2paDW&X}rj z3j5`grQlOpc@Gv`e0P$+n$(&gQcJ$JUc1lMbyqS3+-+e06!xmK^z{V&`KXESK9X_& zhfAhbRHVqUO#yzDkbkd_r|@oO^#=(ZE+?3goBWWSuIzci@$Xm?v?q?ilpJ&kohq|; z%kMW$<@$YC@QZX5)yLVr>W=IQm;;-7KXtkcMcpP?N}xB_VmUp^5KVtkIuA)VWr?}ja~jSsk3*2pUSG?o*GnFd!<}>^HdUUS{l`z)vTUIcd3K!C5?nkda=5|YI4 z7Oixng%NNuRgXLD*i^NqBb`Bp99g*;rtTsiE?1}cZ%!MBdgNXjj{CY#Bhu~I+*(p& zRJCqw3LI~~qOH3yrkIc+>VJ0(COP*!iZ#Mrgqu>N-Wg~v=TY?btALhK0Xd7IsK@-o zr*AN)OC)`LQt4ewJE^Tbm#@+LHUy+(ITk=qfoM;D^u>Kv9K>a6>D`-+EUa7?%tkzb zBJ(uJp?zc?pwZaG{Vr}O`n;@*zV8!1y!CBBVg+lu;_R+Xv*MJH&fHOKhUVB&+|_4 zpNObnEHuS?tfU+^XOJgnob*r?sxY!ij2K*}ZOO`Cuvc=kxVAogZYSGwAV2dVj3-Np zVaiUqE>|Y}b29ijvXavjN4hg{H@U?&dMV`&psmj1Sp3<0cNyG?U1Ag~$pUgVz7iuW{81T zsden;zUz#&-gXgiSV+&F2HqAvb{J>ac#~96#Dm6cF_7c7PPbb4mBYoT)Y5{e%#PJf zGQXWxpJX5ZVH-qWtIZbuz#quom^N|AeQ8+mEnS4@z#j8bufk>FgZ-vGl`bbH8!-LH z?2DWv$^Kyc^I}vON>b)2Ld0xd20UM9k9?I}U-HNjfveWR1$Yh{J%mWh23BiA%=nts?>NZW6So%Wx9X5XD5y=D5g|41ggS)TymKJu z(RFJsN}beKV}AF0%o8_zj2^-hDB#F=imF7o|* z@we=s?(s6b@5mI3skHEDhGgGc?a#8+qa?gE=;Mm7%i9wN87U0q-MyvTk#K6}Xf9qt zPjCu{1gqx}FoJ!3wjp~&zr+$QWWZ#wlx<5|A45E`PE`EfG%R_u1ann5uI`ha?w6_9 z<0*SX&AzX$98Z;ur(+=)xS#G0JJKBucT|SW+3;ofo*wOX)n)Rqi06;VWEr%JVAx*= zO~Kt~D#U;LaBa_CY5gAnL!9Q`djXeyBF|9& zmZ0)9fbVzqXGIzCnpdCFN<8-np3^z)gR2&Y@L=>{w1Y%L{Aa%np=&cG0-owp{onFM zYO?_c4cvF!?N=ngB+h`a?2I0SB>1L7JH*4{>lo14jE)ZQB%NG!@P)YjDz%sEA3?B* zwdre#a<$dJJ;p$@6R{BRt%>Ez@+h*KPDEAj>b z>(s6jDT}b6>n?GSY8Z33=zwod!Nc`Lu-WGZ&bAZ#><`Bw<&_WD72Jf|YLJ#7`3A5r zw|^@bSK~~6Dl*D5-d0qRL(T2oW37PVSz&~@1n_xU-)Oc;K;j7a`X|x1H5PZ#v`9q8 z{`J~E;6H3ZklS@I-acSK38uKe*M6hlh`YtAIM((g-0Yp?#=hRt6~1nXWQcc*>8{*) zL`(96Nf;0C;3hilz&N}We#H!Uu9>6y76td1_5d!>P2=UXBYXXECtzKJC@ zQSMOBYei^8`p_M{Ir^M=Q#1WZQW8o$bF$;rb`3TMG{<#;WrSJM|JSvnuoMY(2HM$g zVnNhqmX^Bp>gMRTe}cnZ+pR8{ymYOvA&4c_y}Blh1Qvi2)hBL?7B8Lz)in!dQ; zy#D`{9dNFZog!L{nT0R zUdz^@*0!ZNAp9lcBM;EJ&Q*B8`G3ZQZn-@}(a)FU>PC;aHV$|@M z;t}Ox#-l~i=;u%x>VAjYcGTBI>1h??OS-^0)K{%uSGj_`oTyD5ckm^b`X<%T-(+hv z(iwgw!lR%sfhkLVi+Ir#thTh=mvA6{>L#U)bubRH-}&3^Qw>v5wkB9&mzdL#&?sjGTkmH}*gF^+rdI_|+#FPKtTBd~oGx%E#$QPk&K54iN@} zh!H7WDBmIvXvtxx-~4sm0(-Bpa|T3v%JbA!WDBFVk%8AGxgp@;y*7;5?3G&Fma(N@ z+7`d$Kn<`Zb|Q(6?w6kQ9Bj2as-rm&lWdNeKd!~u`4(9fdv#^TF;xk%IeXJcB-b~M zB(x;<+SeN)WE_q$TrDv#EZtU{j@;rGwW0C)9D2e{+zO5JDYk0l`)E` z2m>NXOe;H=O!@Yycr$bs;KR&p_h2I+MC2m;P_O!1EDm+~wrCc{WF5k4`f0Wz^hrbK z<&${#i?nc(olx&=C=L?L78-Y&b*MGaVf)*o`V$0w$y*2HABiVfz!jG+^LbnBsP6o} zVdHH(tWFAsEpvjE>FLUIk`ugpXfN-3fA^N(awY7)BbArza~=kYwRz0I-K(KX{nr2k zQsZyMRHpIu`P;}{9@A@em)Du1EQ!i2)s)ADHnU>J0$QKy=)MZL8(B*1&V7=fw5dOs(Yn4 zk|W;iUKFJ*pD91LG=#yf^fpt>kM;2@;MvHspD+sxeP-1p*W4Ya*_HH+@w;3eay4bh z;5^Oj+<^I@%JbDQkKC<(Z_(w5H-|ryi0bbI_CJf%3V>La?b0($A#^OF8q98>gV7u_+tpG@h_;1d(!hV5sLhr(M12ysJ~&Z_qx%E}0lF7P$(p zNh==wMQ#R2-9qR~gxwjU2^00g?nf!~ss9qYcdz-~z2b*pJpsWSjYxG@h!H!ZN+(RU z%22J$&#l-Q*kgd8>^0MJC%guTZuQ+F37bw+_aN>z+`{sQeDwaB$Jr>-t{<=uiXttpxFEYle`tN%_j zz9XosS_oCAdbcD8+!Tpm!u0Mw=?mmM;JGEO@@Oryc;EhlHawf&lK7$ifbDwNsZ>y^ z$5TC#ue5vjHZL<{=vGiFqov-LxY;@|{6FmEz4)}A{=CArL<9VF)PnP{{xpB(vBcah zw_LCbhj8$n#y8IR3CXS98HdwSqoeQZfhmiMucy8og*6+hzWgEOA*l2-q)(>bjku5! zHU;C2rLUMTzA@53A7~J{;E==kS3+;nPoV}Y{){^?MIcab;m!l^(qRB+S}gR&R+N`FxU9{1dD;2ac*!nVdFM zr_1wB@@caU31y zJue(E7G#*2y7Iwc*?r`-Yz&8Mert_Z`xazV`PaD;Ie5Hf-A=L`WpgbFr#??7gKqV+ z1>{XYKo$h& zG$|<|DtQ^8D`vV2cgt=ya>;nvl>aQ_GqDKl^+AZX^j~qD`G(pwnr5)f1=Dk9tEQsD zA1;}>=0rTOQA1yGFAvvKack$621KeqXmhd|BVkGw`R0@$bZ3V61;2qIq0Vd#il&Qh z!aX3RaH0>F)Rm;;6TbDy8;k~sa6P_2T$>z2vCh{U+S?&|Gl{pW)(<#X-$-)P6j6mi zNIhB|RNpQx{JF!|hpyxj&skWd8F|sYSyrc~y6a@sp(eGH`s% zrS8G)e7`eosK|Kr4Qi=2tkjh_z3pnCYE_M`HRu*Fy50QL+Tx<609yvqk~&| z06%!}-rKy)X|@aMu3MfJQC{P%*%=yoE90jUR@65!=O)x4=aI&+Af-3~K+Q3Pd}p`8 zy4vGy$dM2)_b5XTbX@`-riIi0$Yqe&(gT+VwY6+}fB$uPP&h47M2_H=5O- zzIygW;^8xno&L5!9a5wB#vT{i8`&t6G39Z6U@%Zs4=IM^y(=+CpJp$RTpwyFnk=5& z=8as*mc$Q{UbWNjk-Gd^OU+8XX`Xp@w=YhulKAH`#**ZWCQHJ4NiVKauD_fNEm&F4 zY=_oaxoS0&?wr^4{6uapiH`UruZZ zs~P$QK3N(BTCb211>Cs4t}0z++$Wn?A8Q-H3&G3uwUI{mDCea?;9Nh zJKceI#-qkkoh|jM4YKVj{QhQ{*>IIzUr551mYT3A*Gyma?;n>YB;eKvy=lC} z)(I_C2pp6f5P1{X*QCM>7UJdvUKaLvCjK+TVRG|v5{XoDIBz8QyCER}UH59*;L}D? z8M;<9`&0g%xHcN|i)YgDze0-LMzUyY9c=q_4%s$^x$KyBDYht)LkTuFUJ05l(z+}s zYSm)-!GCUBk8K`f<;*|_%*Mk%Uam6hYa(HbxLS%}aJ3j-i1=?JqfL_U1|+~$WOGLJ zl1Y{6Op>H_mjBqH8vLy6L?mN;tfCHNb6$h=Ll07BU#|5|@$6$;mviJld2O<-a)FaS zo12&YBKOMrV+E0w|fJ4hFbBm z{md!lCEdTI3hxgVpDSCxxjs6UbiL>D`>BH-#FJ#BjzLBn2zc{b3MOlr{li+NjzafuD!>US1afXM+ z=;k*gpeZGeiFD80L+F&oSc3b=1U>;dG$$|=k;)f zgcS%SBa&jezSC#IwXN@?XF~h9CsW#iw;K|)7;%SNFtli+D70m8kMyX)3K@zEb8nmQ z2JE@N1wqwtNBOIy6amoV|I#EHq>ag~O7hDn<-fIy{}yWgqgnmmByyz}D~0I%D@LL2 z)w<8XwT*u7Vvv0@`~{Wr?U63B}yM_00_@k@=~RVf?vX#jPVL2;NhWbxsTxj^ka_28wHMNbUZHE` z6*XZk)FU+Qm#nyeJ89&L8xoC~PNOZ$7UkN|7u0fjl0?z35<@<;hJ7SN@BL2vOctk| zRx0hMWG-1F5fKq%ve;E=u?2to3Qb!ujkx_dVn}7|t=wD$>5SSc71k*_PaFmt%ELz| z8qZ*<*;8*{mS;EppUtJtOhccjZMT37a^r;P1pN+1?hDI%ntn0WK31blJH5QT) zcrUb`^!OzJhnf19K3Sbq7`sQ?MnQ!|!~xB?B-^?3&Qv9|qdfTZZGZ{QIWZUCi>~ju zkus9FVnkfaPOyR=gdU|gdz4BYhHiY{Yd=*1FXmt;_J0!yrFf#!>1j*lOox9sWZ!{2 zxIsoT$COqrDyd@*%H8|UV(@BMfiRG512P&&S>e5qpKAD@xmMhNi+G+&6j4oiN?X6b zQ7}=R5O~_B6K)o^N+LlkuvT&{*^s#K72b-3##3ML$w#`1xQ?@$3Qv#LzYX|#>+^#B zZSao+jCA$1ehi=>=&$vl;&-EnKmlj;lkcf8t0865DgOI=mUQABfJMXm9cNaV?UBn> zbR{kLipqyt0I~c=jR2&k!9U%VC+Ci?7vs4OP@W6KF|1>+rqgEDoS_qfXCAvK&hCz8 zt{0^6hG2bu_@CQYScadcRECf?l_zH2Kl;F^^TysrE8X5sE4!@{+KwQOTc3^Nzx9h& zjxqG~A@H1igV`E~>RR}2!o(V_rP9e))Aa?0)BWc0IcsH4XRZo#tbYM$LRr}7Q}OjdW$*^`gm&!&DW1NWsN5)rFit$Pl|&?KxKG1Mw3 z4B=Lp<;1bK)Xd@}78hZGUjV&L_soQYtsBmrczEH-xX>2eMi+AnQZvETZn|WX?WD|) z3#QokdFrx`Tu+8ss^i-PifinLw8P4zP{{F8SU6Kh)|a8g!F{rd{3=yKD8I3<=ji#D ze$KDDSBK{g8!a-TKd(^OgUZ7bJ^W&L$&>F?QQC0`H%6ni-!tCtvjGHc{JAYiNA>jZ zY;&SZMi0cM(dQQLV0}^`RuSP8S|hLI^ zGaKKl7;ul9VhCu^URVra)~Ap~Qk2d$Gma~xsh;Ei8^7-qGLkLCZB2)RCmxrGU{P|g zD;kiq51z`;biTFn==vT`F4S|mwHKYAHvb1O4EFD z#m_Ps*T>3Vjz>|_Jk-K3zo8Rlx1^#Hqh9qS>tJ-_#E0LX?va^WwE&1!!81t=u&8j> z*4U`8xnAY1?);5;+O1rT=Q20Imq}vx2)zKj+QsggKoLva38YfF{>Xsw1{g9{osmJA z!5$L-MS#8_i;ebeU@k6@9(YFkK8w_|V1BhZFd13qihhdKH7IX+Isf+%yi?B%Xahf5 z3vK8A%)8F9evV)Ftm%1@p*eztKd0;*KF=|w>Ecli64|$tS3H|*WGHDn%p`d;iuS^E zGidQ%OIj z6n^kT`1{_Br&duQ4w89c6!6(uQVtY*f4fJd#e5pJopwmKFma|xW6tmw~hA_y!AbgRq^(79gBE~Egj*P#e=X@o$X2s zlc;0zM;5qaOmQ~rRL(FNz}2?w?J-Ro7JH!jQM6o)g;go+?#sDe582nhGWT}~+W?$V zQ)?AD2zn$%rn02)1E*%ntM$yxZH@mB_*=Cn8OGxF1#LgWQVSbiHEsVE8MiMuKi6hF zswchjyaR}?3lC~5*NOQ^&RGzI16RLe#EwjLosuuni8^|=9?CT^Poa}DMppeNa?^Y* z+0!lyx1X(gZ#}=O1^gZtCPq!Py^{#~u}BF0&97Cz7*yF&ctw8>yjhh#p$Y>4aH@^q zwe@C#HH`XKi>yX}$(nv9wHeGqyNA1E#q)9%(mD`Z;q|to690^Q@6i@I0h(bSx8}$m z#XzXA{zL^Bol7BV93rzk0hz?zdeeZzJ5)OBiR2u&6&#dly@N^L+>J`lZ~(7EL#J1e zN+G>CgcUg{czRk5BUno6u3xTlZtjB*Q3~?dD}QSri*p}P_^sJ`US|;I=@7yb;$)vW zHrPiVAgVavlih7{>p`n%$LFha1*`UhRumSZ^LvLE!Rx?NrAua*DD# z+vT*E9Q;KVn@t<}3*{~4SjT>KVl7M?U=N!E`wghkncp$Tk$>tuDtY8tN>(n73(n2r zYvP;`3~y@RJ-QDN9i8)pv@B{jw#(NjHaiNJ--CcdcWFGW_5)(9^r~}c)3q;|p#Q>@ z?!XGSxM;kEzXw`9n0SCNd^{4W>pNrJ+8B(VY`5sh0HJnkrQ|7v-2?shb9#HD1(JRx zL>=32RD$l*7V22PJlxCiY;X41SI?5v8$eU&poD|wIp{GD$L;Tj?a+Wn#$vo;8Dl&7 z>F>kaH?1pdX&u-LDm>Kx&KFcsDLGx68#?;U8u-ZLRa;ekDciU7?rK|ShZ`94Y8M>X z4gz5l$z3aCM>Ah%nuTEWufWwGjAi!)8WzQVv{-<@O2Uj!4s)D_W9~xfGg^ECx_QS% zkgtq$LZ}|OU$cDm+{k*zwxCYk$MSk$<=*d{12&Fa`x*qkg1E|~XMaa&@5h~e2{cb& z7!%FcOjw|TCzvhZ(;YvX>*cA=#;<71?$2i{HcEB=vLKC&Z(UU1mI|iS(JR|(hiwsz zfChSnWHtjRl^M+E;oB#PSKr!Fjv73q4so*hQ{85QKi06|1Ozhq8(OO>PkbH``Xykm zre0ZEVgiIrn7*rtYR+QdvxL=Flv@9@J)pylUfois4i#bM_XF9jG;@RdFFL$w2 zzpM3W>`ae*Bc9BN;k)uCQQo9U7l`INY+smCTdc+QU zlt=XW|4Du)zGc#yzptTaGWq$o$idZUILnx~TQSmJV+##m+$P zcVy6mVC-h(S7%rE>ft`34nUn8v`{aR^9=Fa#_KOT(MI=Ov}ZcVC{m0?*KT(Q_KU*6YBDs`g!{yEjDuOAyrS%k3>}dS=Xce4jYww zzkjccGhnukJuz>yr=7pEh^Ow%KCxo<7m(MQdm|bqX&j8~WKUCsOZHdNe2q9%W>}3l znKaoNV~;YQtKJ*dPZdP*OIsti4EKKjNz5O?gS8tthiVB$WlY4P*6Ns}baqNze-hx6$m;8zsqqG4 zq$5=2hJ_$1o!vT`>g^E>fg2d>;00|Njl<#B09DzHLBuH0eK^j5KDprU{#bP9M@;18 zMLjmoxq0VplJu`E2?r{5h-dMz+(Szs6zQ6Di4vMkMl zueX*Oc9{P{M!P)zCB-o=L)Zdrdt*EDlX;b`_CJ#`V5)>uvdCjzDiv5C2RQdTi0b)( zeOg^@VNI-QDzTF=;Y=%ph*iUNE&xmOBm%Sh6iT9k{mc&y;iF}JpUDP>6#0m@E|L2n zM~{|GxHjtbMuxZr%*8JE`=|Q`{s=X`uPo5d)ZJy|q!+a2H@az9j}6kv&c%vo)!WgL zZJNPDo-ikG#>~_z z$e|QhHnY?dS4p-W>bswcqzBET3V*kUg)}(yXLKzvC>_~=iGOh}ih=W~uz9zryIQE+ zAf`vW7wirE=f_7PR*>ulG}nuFV2%Oz+H8+CxUSvRs{a$DgHm9>m`P15ssZHIT+8}X z=QPF#VVlLks{tERhDq@V9>ri7;$J40O-?^&{)3W}W7XivqTa1uHfzhwYKuk_&heK9 zipHKg@XFO;^1zE_clmA3m=u^Sxn;b*aIg`w1fKCzV5Q0npi9&RMKpKok!Ba$Ot5$o;_hhqiQsmvSA|rk_>~L-z zlcKB?xRETsRitoBtz*l75Rvy$Vlt?spfSY_&ko z<*o0fyllLIu5E=M!>eh)uiNVexKyTk7?c%`+F;xg$`=j1Y8J7}t0`YV(<;nS?Dj^6 z`DACRoEiTQ{-)(-^CV;N+Q?Tj4Eafz=udZuE2N>FX0UvP$jPNl?)c#8PW_Xx&U>VfG7Iv;xfDh!9-@#;Y;pYL`N_qg`? zY7;;?2%d_9iwnvY7rRV!n5+Sgligz#>QeZ{-BgKd!xo$`W1jON`k4-%HFneb72Y(N zUVccQH_ezDW%F>ehMh3fLQ;2y-iXj_Lq(12pjTC1>FSu>#DF3F+UtD?koUhqrG_nt zXlJ{msK(Y2O~Wt|T_MKbErjg&m)}X%puVi(Iyb&Fu!v*{!fLNE*-0jGr^kD|7q2~$ z+1KvFu0Xae3JH)Y@<@Y|fThvu~$ z4Z4I@nDaG#TmMpQzSr8&%(OQ0CVuDsn<_y+bP@O^tky-<`PsW?Q)$%t;_z`94IG{g z{cQtoV&Aj%yzHE;p$dTdniwhAD9QJTGP(+#3L>k7BaktL9PV5fd`NJjFoDP z6NAQMu~(tAAK8V3==0Z@WjrEpR>QQR21sPQ3P$ZgXFQ0Tm?}@~l`-|ZpV&f6jo02`jYeuZ z_bwbi#^}fDdPX(`{+re0zFNc*9msyZ@sD>j0i{bdZ&Q?r&Wer`7acA=7LhLYl!RT! z*tuJ~85SPp0wBep`RP!0%)>1TcKc_L=rY2J!J@2cA#F@2ki_pCyite5XISFak-ZA$ z{$okUOeTg%_8a*vEN_shdtFX@P%jK1d=X3_G=Fa4pCzU))K|5*3QeA%;&7f* z9(yM}%C4IPd-JBfUqb5%k*HHpP{Z@;Ub46NJw-yTAV5MrQ|0pQ%f)_-0p}$SH!m3m zv#F_8v42+tJl&N8XfV0x0UBv1?LH?ur~^^r)hH0!BLxC#koiwbk5WEht7?mE=$1?= z08f~YD~O0xpRp~mZunz96emSR%^p9}@p>k$_(teF+2+BdUpvQ@>T=re+RiKLU;MFo z0TbXmO?G5y@%eNsxg%)h{`;H5&S5lzl3AWo7{aKYjLnSkqJ8xor7hedMS__2Z~!6S zK~X9jgG@0EbG)c?uyUsBOxlKsEDfD9_@jq?h`j`6EmSLnvM|LZBWhHTAk{Q2!}T3V zo**i;^Hqm{r{skZqvTFUn>0u|$-I^`PQcv?_92@J%Q$?8{6rLqcN%$0gmKO_=pcjl zy45aPS5@BI&t*Uq_sD0v_51CMHkHT*T3&p){p?5WRG6$D>dJ_i%Kz*ES}kpbhcyOl z&y)8w>-l8nI~9b%$%jQbU#}e#g1PbE#$y`MWA7uYad2#E@nEz(RkCl*vLwwvTxI|E zAd#I$+dEzPAJ&NLP$(H^BPtk<;Gwe#H?>fGYHZz=HHeDodM5)g*Zt>eHl6!?0pZnjn0Ay1n{okYIbduY_LRtwwS^u9Z z#Psd?#9md%C!I%yM7-gn8zUdoG?&O)Y|eVr5)htEcN&kQjNMakC3zfAE#&r|RD z{&vVT?l_z2n3JR5p6obj>98Q_2YwG)%XY1~MWvN{Kc8&-Hs0QJ$37f-kQ;%>f0;dW zKQ|NQ+jWdBus&PjJ-5X?CT(q>dkh}mUmXsj?bzk)s9S9q$Rsc*7m#ZiK819YBBW(R zBIjGw=XaBdYDcBYXE^-Xb_D76+BMz7X;&!yxg$W7L-15d zSjNu0<2a|Ic~v!f(x~ahqU@WBQ-0OdF>BBVN>x6un)inXVxdcP`#}Qf?UMvR$wHmI z=6*uQQNlP@nRGniP@-a%Td=Iqhq*v#VM;$UKihvc92N`1=~T9N;t)esNOGchsAZ%~ z*3FCz=v}L07Kqgg6_j_|#aGn=LOZdAQDjHNUMS^I>*a;Q(yu0#0y~@1%Eu!M{$D#o z@3iu75T_^GrLyu@yv3Q>s33IQTBy)8054?uEa&$9Gv+r)rNidoab?+#Vr#$R>PFSv zXxcQ|FEX0x-;ZeqK20=2g8uYV?I-whV!ND^1`Mp?Z24HBIz5%5DxU>F;TP^<)*IE8 z%N9QE?)u7pgs+P2vZW`_IhA0f;{ww0qNmcS^pa}Khld$Ido>WVFjsq6U#fse?2*r# z!vmPHu^(1#MwY)Adwa-OZ&`Ne4k+*@;hlq(ckfMOPAh{fa)DffKYt|UCM*JAA&1~T zoFk+7{6aMmsXeL%5=Rt&HU99Mqy-&zb5+Cag7g;Le3`n`Y1ppdLhovwAx};1>y`=zb*OeI8p5N(YLq3dv~?b%@5u6+yd`vC0qdS;CO}u zNQ?5WN`ALZLr`N9qy2|ST=veT0?*E(7WM0IW&{ACy^YIyd){PGf-vc?uY#7n!gO$* zF4(LOsdP}Ma(jF%jL{FI>9>-QVUZhG#scM)G>hl_^nEHBLXl9D>Ze0h{l2InOQ3v# zj3LTPX*13j8P09UHfylt#*jXhktJiAD9@1wVyq$MMLffvJO2$rj*AvR0phEjxyyPr z6jjIYlFB$@?|#I$RmqqavxCshP?f3gL2mtS532iX<Tc9qYO6BAu}+Sn1Z%%%|0i2BfutdGU#O+d~fr{jj4|vLa({ z)EqWV9g85BaM8y{s7yA=HMRXzPro`th6#i{2wuwdRa|IFS$CAUPbAQNovNy5_=4pgkD)C~;A1nI; zJ9Y>ib6xgS!b|s^z zx+aNLr=@5Ylp%#jWK?jb?8Y+=9ob%!v^U!A>@+n ze%|;m(jNU`&8eltC_sWs`B=l|BlJ*%wstSl@kY*)V#{V=)~j&+h(!xB$^dv#o1t#C zC?kC8n3@93Vlw_g)+bDvT2%^&u#5glnVqQSe1ztjYh$)kB(!N8U8>GTlm6wvtOevA z2A#)(>4Nk7uHmE+7nNzZty4(D()g1F>*lqRKh@RF<~~Oe)#STStk=V8rl`iQ@^g1E zbXxA+hi*?6X}At4#RC|V6$@(qGWTOn6Ot4!zO%RG8*p>z%1Jor?%FjfE5A>LE%ihY zwg8$oiz2lXJppKuy(vdB&|2@JaHYJnW2alqPWi?Q^Lbk`;<-LD;d#rjcmeHj77d$D zP;IJybV*b!VYf1ip}#mE_jnrr`wHQ87>bpCATy{0=+Wf$+Vb;}VlQSl7@(Sl!2g+% zfzJdd>-FqGLl-zBq{kcdENM$IZ-t3Aqo~5?qzE-!!gZb&(GY0cIm#!pmn4CPY)7?< z?VP^|j&KR~)L+ol+5UPLGMPTa2?Q&4NVLKGgC4<6Dq_@E+JM9)J4 zt0j*8h4^zXkS=Rq`l4!l(2i}khw!n)b%}weRW0o>Vsuz=W_h%M$m9}9w1X$Kvl#MQ zkeBP2;@6kekQyL&pTuA$Xiwhyt)G|Qgk+mDMi!tZArcLC+L_xw8nIy5$c6p-u|6HU zIYi7%PG=WJ_*Fg6t}bCspLLL+Z`J;)iYECjl4LvV-OuL-PX3$~h;|@%i7oAb@Cesn z&p)l+i|axGMjP?qrPI!!d*cqbPi(hGk3%?T__zCldf&Rz7&>K3(3TI|KM9X`9dv!m z8o&m3MK?d5D;@hNf0};qV7=WbNRc6|GK|z4r2M@u0{{@EQ8Et?!!>c1tnYFm@1P~~ z&}byuWCN%q4dW(|QTiFXjr*h7&9x|l1_Kse+Qz&_Vvn~&citmflc6&P zA+}q0VFFXTORJLvl{7iOwi#A}tqsOD`gSRSn}&@!L}^-yetpP?sPN-4+grD|lFbwu z6Kyshj^PVj3iSW&Fn$4uwN-IvNr#W;3kVa6;DischiUAyZJQAsRQ$R#e|dhK_=E?b zMWOd+e;?`$LNQ^!X%t^JxyGbEC~lkgY~iyDXqu0EMMxbhLFXN&lbIv;0j_m=d-5$? z$J&xFd*BabCTm4Jj+JLD%%t5}lG&7`856fazqiLQRTZ;xkMPs}=MKlh(P0yJzvF}L zqy5^8?B>ihcv3Smn6Q3ia|C()1UV>{)U0@{c5M$vu_j8n*ha!?&)O#upg3yFcbE8z z_*JfCNfH+~xJEPtXb_`5VvnEp$Bq2m_x?D#5{=6v_2Vb^_y~)Wrg(MJ%Ydw2!s(wL z|Cf=IO^Mb3POIHP;hB#PvwlISu%&_9{ifVp(2$>c{cK#N99x1ipv-jV-yf{je3$~) zNa6O@3u%52UgtH>EJc+*)LSDfzh(X#Q{tHv>lZ7h!;gA+O%}*Rro#K#(ZRrz;W5JJ z@ABjgc((8*wu*nLgK+^v_)he`)HPs6uj~ANO@Q&m+GbX!ZR0dl2=80cAe&VX<_z(m z^A{zkMA5G#UF%$VaKSPy6Tna%Z0#K6X<$9P9W=r`w~snJ5DhTbZB!ZKgBwf}tN!xj zG=7K=-pM!bIPV@`&&;PO7gABQHll(n6R>BB)*ap*RJaP59%xRdOe5@w*?HtjzWXk( z2_A6GY)>@p$1n~QIPN!p|2szEg&e6ENKH87nL5v{YzgJ-h8tMtgy-9yZR-N!#TW8; zdCo*zH`f2w(}I=$4yNymg?X$IgI?d^#3}+(i$UU@(@&iX3x3gDT2(FDVoi;)45bJy zTYX#aOo$0!ac2#&nX$LzVtX#fV zt-SEOexv@pF};HjwMS3^>rjedqjB}zYf5z|x<7iQFoiY??^Mhcp#~DlnaPGy$)`C! zqVY!uO11i#q2T?4Wl4rmbks6Z-G*>MdBD!m7f1oBR@HIZ-%(ZaHWEa(DeW6DUJpC& zx31C8l`$lp;S3@W;cl}O33P1TjhR-#ppBqnLOk)5ObkaCy;Y@tU2wAC9I*L>CYePB zhbM5@@Ohqnsz5fk>?9pF8BNYB2;P4BTnzU4U=?e!(ENd-xctQ8{MC8AES5X-{o6r{YHZ5$5ty*bf3`_I`2FX@(SE)HYYDz8+ihSlqH{=u)&>|C{@gu$9&_1`U21&nnrq8`i z?3f=gwbOHF zDYHie?aZFW0-E|2tG)aRrv4wwv_6--1y8(M?VkrQ?sR=>*)`N&P$dKqH#cfMq?$u5 z47X8nM+#MVqr?4-h)OG$_k9Q2hicd1&|SvU&<%TD&QJ@z{yUesRI5R^VZ^+J<2>U1 zuk36$VjL{j{xa>KpfcNEo&7F2`(1$y+6ag^45%diEjWMK@Yzdzet)QFlsTqTXddY- z&b%FwW+e2nb;ZQOwe0k);BcsQT(?z;VfY2!rD40W2zXTAiaO?t=+N$Y`^s-uCpwk( z0Sam7^|zCa1xLWqD?VLR9?E1c63p||#{QMarJPgF*$58Yhvjzcg?+cjd8Zc8jQG#` z&27tD;IAe({taBs&F|0j?LDdZ_-F1eugG-?1H~=;l5Ae5QhS-1CptJKd^lwOC6qj; zMYUHZs0|SbHy5%q{sgQpMTg)D%lqvO&JUN+xoGAal3@w`7+l?zsS}!4GkH(GDa9y?r;fG7;40k zo6;k5F*sDm?s9_I1eo0zK)N7Znhl0KJbk^vu)U@&O4pWFNT8_u(yi^N(9hoJm7;*( zI_dK{Issdi5$#T!etIfg*hJB7tl%6_d^N&pFMx_Is5885=~Puv#q49gePBe&Vk`o^ zC*(fI66m4WM>#MF*$n-}!+SdKM;U1}iEdrT7m=!G*0rY(2_Dd>j z^;iN*xwN3CEPV!Le$V9pic{!15rd|5`-%@|B~L~j?r06McqiK^ z?Vj_37r7Y09Y@OvG`3vpjM#_x?-Et_Q%cvRuR|Ra1L>7@uobXmZ_)Qy%zkcvR_vrv z%3=FqTV;u>g@G2zja--+gGM52c>hjsp(J$N3A|3f#i^f9CKMU2%sdgj;RtbcO*Bl$ zE8yx1myTZKN7yU51n&Pd2>-U_qq5TzhcgJnzXTu3uc{rNVwIKscv_P)0H=uzb7Z2% zroqt@V`3lLlp-n+ddHwrZ1r%4+;#%LU;|pL&1>dGV5GzC#~1kW;B*<}j!BruivUpt zjk)Bo!)H=bwsUWH!i1u9&d>Yo$?MCx{|09nE(Giyz6G_CMH)v=MAqoE@Xd93EyX=| zR!rPVwL811_XJks&-&wE$Fakdgf;ve9Jp6kJ`|!U`3embEWJyb9RqU?uPd-`L-`PU zOVD#X6fdSe;-9}L3sBr`*YbLnVACxSPQoakV~E=er-KVsrAc4h#t6?~)T<3*9j88u z+hoO+4}pqaxq{bPpY`LZq7li`lr{AVx3j1Nnk~qf_R77P_(}f93hF>jvhhYQP)SwH zig)INFAvzs3I{JquCkU(F&r)>w_?dN{{r{4y5|oYW!R%3nrD6L55Rm{%C8z59NCSP zw$&#ZjE$|g%bIA9cJwk;lpaMh?85r+9PQr&`IuOv7=}Y>4UiwMSyFtD+x*)j!8?GV zlp21*pp=`!%DEJ@Ly?0nsQM4~8ML?0N6j7=Lm98|Y0wP@$ zqy+*(qzM60LMKR9s)Z&9NSEG13mt?gp_$MmKtQA=QbXuvPSkhryf^pG_vWAZX8uDV zCwuR6&f06Q^(zP8G9TsG?N_=vJKf{u`~jR)yw=E@%~w{Gw2MD`_Fl@R(O;P1SO^A0 zc1oy^oE7Ud+Ss~JxkU73F8hFOEx%Vm`Q)m(=RO|wEXMNq7oO|xp5CxcMZHj2?OvMq zlO_9aT zUC*?t^v}Y$gyk={mDDx(3amW~p76QeYOy*`4!EJi6H7Hhx88v+KAzVw$FC-I(qr?> zn0MvMIzzHCk4tu^*FG_J*HdxwyLn#@!VcSw)IG=y$86;{#)MW6aPlAQIwW&y2dvpE ziK?6{z%$g%2!#MOz)Kgw5<7!d1fi4&g-#wpkHZ+&i9|s#+I* zdK7l%qFryZk@}@4Hs-f`!+V+Ixm9l9Ra;0pQDi z+kJ3MhnXJkT!VP6!~6XMTJ)!mwN6#ofkwiCJ^8H7{`e?iFAqFUQrJ+?^@JHVHoXvE zu=+~G`c{-ORqVL~K#|1Us=uv=mo;ib_=`u2vCkq{ybQd1zO7zPvH4X}fLTTqTEe&U z93ul}KiD`a?H_LVh~;>eerwGdkjUkh$nkvpjouDo8q4Lstp)~tIgPRckpDLQhg&F=PWOxm!cuYA8h zIyj>2shL&%R?Sz9W8iSZ;OQ{LQS5mn_(p{3NLe@fd$fLQg>EJ#^!ZLKi=+ALK{)lk4L(Vnd%H@b@2t z<7x&(Som22T@arTh47^<|BW$%U!M1{{`#Ex-iI(`uOI8N2Ta*8CdcIjhj(Xe87wD* z%kDP9Qcou>{jYl7F7ZTAGD8y}S-nf7pI z)H$1>g8U=%KQgIqa$HlV;`9V#f!0kMHm8vI~NS z^A{qOtke+^QDwzZWr^})BoaupN!eZ)&>u~z=^B-%7>VkJvpX9{AKrc4zZbgML1!+JUj}l&92UY*F)r;Crc3SS( zH|DAMtwcKJT@9{odBG!Q`$(KqrH~EZtXv6W(Fi< zaQ*59wByR@-Igcgh6A-VXVLd9^}QAF0oAFB)NO%cGe*e+yu0aFZzs)?^halJw|3h3 ziB>{yv&0l>8$i>i-_0Ck@MnW z-gc=h`dKGmj_n6-=4+4gjY>sbywBN3zh-qx>bM`*LqEPNGa&16z4T3PuP-*iZZMqi zw!!gvey4uDoD@U^k9X_qB{#NYyV0vuB8Tr{!6^(Ye7wWlmeZ^4V<1x2QIC#Lc`pNV3P? zM%g!n)3-*t1)zGBIWLGseBsvI^@l`lih&tB%|O0Tdp_w2_F_YD~f)+TlxF5*+-kkiG<57cV=V~QVf#?sV?ixLY{Qx z={9R!ON76PcV|gk6N4-z5d-R#fy4HLYsa6`BxW(k5NKOh-TNhaWfg&Wsh_7rV#z!ChYvSM2!AuvgOq$2gScKD*<@woiy~2zSS4 z;CRqf>j~%9#Q8e#)6$JM!)*Sh|=xwGF+&tGysQw3c3A+%nvZ%^e_Bh|>& zH+AZ%1+~$+pM^^cuO4zX9MO?^-9;UfF!lyHE2NmOTE7T=}E*$-x-HmGb7Y z^INHI6Tkc3XEcF|EgVP!SkAK9jU*J>?7P8c^U6&E?>6)8CAOB=odvea z`z({2EW=%vt_}He0RDqAR75wWVwx`Rk!|Gd9kBU?w`IDe^#_P|Xa08Rh@qVIUgw^# z`uUDLm*dUssoEG23-CvCdkeFuDT_(?uY>m5`hx?0v+W~XP)Xfc+i6F>L$gF$3g`|1 zeB3az350<&0ye%8fG;VRz8H*lRNZ`fxF6iAQpa3wL@P7U?CCX09c_9q^KftpX*oW} zb&z|s-;g|oygC@QU>!j2D@J11xhGd^GY$d8pUs+~*`KAyMygyvx5P4zR&XP|nIn(O zk9G`(UmWj@$bh%(tSb)y4LGdt9Qj+a@wn-C#f6Rq_fkBP-SH7BqiufBT@LgVH!2I{j!i=LS!gQpmZkW6j9kvG|Os{4k zFjT+lUdP<+9A)|#)~s^S^Z3W;(Lyu8SZ$d3QlxNK*=hOSqDlGchyQ{D z#B{@EoMm@Q192HmY?t;9I#fot&npsIfsf|-fkx(5$}{Cs+y(|(tD0Eu4`YK42JmK3 z2MU-9c#6kQa#=|-l!pkK%6-pXTv}~zhADs?V@1^8Ck{I3@oum#4yHzbx(@yEV)lw^ z2@N;l?5tie)%>ZD?6L%8;>hzh^;eySA@8IE?5qXO{q)G6mGLBBx@>pE66AR0*U#I0 zIb{Yk>9>^gR_^;^@uTenx=!Sg_D`f;uP5*lmy&&ee%HV}V9uw;j}u}#p}OyG%}eWl z@T+DhdUPc^K#gT>KKG@opU|k!*P$9lcu>YYJ_hTe}&8 z#vKv;iOxS-d*45fc4jCalwqCt`Y%S*0A3 zr2^QPGF&aDs#@HeL*?b3t;L;L?yWA8ETBz+)%lbNvG2`Nl9};AOMx)-4awF5_+ew{ zTGX>EBWWjMIkiNx%t+~b46b%1#SB3YBA=m&3AIm(8kxi+^>?fI;74E)@NrTyY?dBg zpMUZK_Fg)`ZbAi^s%LMH*jfXepuOO|3cf3%?@f&mNvF4!8}s~rWAWt+T4r~tul*;N z=gf{FT0W`oXxak=37p>?7@{)!UF?g0TglP{i2eXCqVvl)QLG|buV56gPim%9u*O<@ zy|$DayV_|%h8dF!A&E{*3EnSak_^6D@_$EOXYwXg7W5w+?l7)eag?peG5B(C7wUN4 z%1z`9Hc^P+LJJE-yM0hX?LFjnkJ`O=KFrFod}RftgjJZGac^xrI`18Pd9#SWfNZ7$ zovHMk0#GN!vqZkhi#c;VI0cqZcKg*W5BcZ6HU0344&WjGfRCvi00S9}yVSX>A@+s=y? z8*U66aSSsZN}m;o3+EmX=~B>?(+&BWGGE*3<4ztb5A>Gw2~^-4ad7-A6%6WRb&-xK zeiWa+3DhLijL&wQSLddVmi{=lR~u9qA(&traKk!i*FUI=edptKPsLeB%jx#|hvcgM z4C}9^r|TlJu9(L-CVH7XIlP8Y&pv6YuP1r;S#q2r#~5ec0~elI%~+m$Zh<%>nK&~W zRhPB>*yJWz^OYW6t{`cr+qFOb?NE=Ncz3M)bbB7g93yDLUK&L>LHuG_y)Z&&?n~rf zIjudahWvk*AVUclLtj~oFHlE1UGD_1XJ4=q@X6+2GhN}VXMZ5s&Bi@?BRxal63d5` zov&z^UNJ+ex@WSUr3MpH`f6#ZU7Popm&?wFLMI^4HZ3Tm+cO|-AlDCuIS9NciK!uv zbnmVq^Cb(7mHWfuXbq*NOds#doz!yX#V*l%-wN=u7p)wNn_!dbZipJKp8AX;D4fmh zQn4NM3Q>rQ^&Ia5$j5(TnyHuY@A(z?k7g{Q*7QRB@I3J_$uMoUdu$WW=v&&;H(L(N z)O^Te1uZs_4-p5irQTpzMOKWo?r?(FSOxEo4~urY+kxg;=+qp4&|XpELPO4fAAjZB zi$sHBmcM|H%*6qCNBbBg{X>NFspsbI>H_((BRVB=YLoS|ab1spyYg>wQ1OvpE%QSj z&6%$3?GPUG=av>?6zOidgKWBLM8HWv}-5f#0b2 zX>cV`3VH%q?ue=@6o!h2W3%U-O@^Gs4X@=)YsAx+9&pF$6@^8+-ke*dJ`5su&q#L! z*hvlw)Lf?pnXv`l#Sja&&0H$In4GRAh%fDBDL#&@Z+?$=X`dcE!R5kor@m948WO90 zIFa{eEsAPt^=Qw(NT*_QEMIDM>_~~z+rGDwUr66>51^#9{G+6NDu%eaRJfHu4tF%m zCFq?B=un1xdkpmiMMLWyznTwHMq@rXF@Huq?*Ql-4=0JaTRm3YnGPLZ!WI-;Tq^0Y zvDw;~OJ8~Y%h};u14_o^ABWp`)tx{9Zf=7A2=E_<`_mPP?ixGF4@LoH zXER{r#dTz{x`~@(BTEX)lZ|!o7KxQ6Qa|CHo_JwUE5HgX;tC|Oh;h2)K@CvG|Q)+j)XwT7dP|)_nT6%i! zzkgCh&IxBjGA?PwouSS=2U7;xvC|D&{DBB&&bMXQyku(y@*5}i5*9&rxB8g~gPBrfarWZijR;eX zz^6<@-p($0?*Ms2CEu#?-m<2R9y=e74OVv$N{|#Ai1@J`d>Q6}gVvSq?N9lyQXnGI z=V?lqow|$&ahlOwNVBdkWijKObW^zq^GVhoT2Q5?Sww$G8IfF4hISV87%h*Q9R82mm-@kNT1H!_|8ks z`nH#|({`DaA*tOecH>T^C)F>2d||vIuSc;wk)x#j&*c)YcQpg~09ERz=IJ=P3d04i zVBMj#%wAQN;>8eO!cbv5zDYdY(AWw4gcEmN(x#)wV*yR{2~75tY*VJliMK;ajFqh4 zt!M!6w`Jud>F`_C^}J;qg2hLfG_(47yB=q69;k~39!X39x3%-FdY~;s%#>)^vCD%? zwgDNu2=eSbk@Mp9Bt~ck4iIF3tVy~`?l62aHy!5@4pbIv-B@$xCZvnMFLPeH>HP3s zdRo#4Z+jZ-Et?8nh616*=+QZx@T!n@I%an;vDAeqM3|^e@8s`Ye&A9c?V2s_VZEFi{cUkA*%_`Z zD`gCE=P6ll?ygi5p}^9;xdyqA;ZMNhy16qV7`&_l$-_w3%a(O+r4%yENI1R|;IvrT zh@5xm1CC$@eE=exz7=&cXxiY{;`f}=QU^Q99n2(4L;b>vmqEKmQwE>|hV*CqnrnNC zN|ToM;ewKtw&i^(ChtP@sGR0tyQ;r&bHQu-2MYm;b1=8@ekj8gtm2t@JO7$eM`ug@ z95=8OzBaJEMf{`#^ymF|P+a%|cD=u&0+PBQyFca#EP0@<&lRQ3L5)AOr%9jL*x`Gf zNDqU%KAPra0LnHRf0lK_D$F~Tg{I`Xu4TkCwG8Wo7g-rztvQKk;I#sAfy#5s=dzVq zXc$yBs0PxkRe$%xgLfa6-$}9Rk^h|O*p-JM7}-y!Ak`rciqBb z9`|#!P7k})(jkhK=^t3gu?p3{AB^`Kn9FUcjfaR%Mj|ACRxa|GvzIPV!(JmFVie7d z>QZEDwZ^OBSWYd~W_zCZ7TaR871_TPm+3hbRsycmQ^0fI&G5B`4Vx5?2!r_Z$IOYmqG>(3wT&C!Vlee=iXP@Gy4k7X^-ItFK3@6l=~!dx0_T`w1dMI=qRjPhGiRTd2))O+=_Ojx zN_bQLxyS2!`$m7weVnhd6f(UlPnUm% zY5h6kb2QoY^h~NW^u1@GUCTkb+d!?tx?kM3C!TWC4!Nzx$|$r#<|qoqQ6WI5v6Zc7 zO7lXbUI(=2bVzn#K&gs(nr_5 z{k9uwsm2@6JmZ});mJ?v2=xSSltmaYSY?MBM7_uPX&aWfR@W*NOez+>z`KdGQq|7l*kAz> z5Lve5iYY7z;HgYX5_~5_U5XS z#c&sbrUc-V%Bsk@Hjg8kDMV2hJ{O)ZEl--`_<>0@x34{&75K8dgHlytNM-Qi^Z#9` z5GIr|v%1LR4bTKx)bklWGsOF3EI74)IkD1|gvW9k&}#Xj#WNfmdPD8!z`IV)95ZJb zKBUC?uFI=ghMDam*j(A{*5%7zE3n?vG`mZ<6PS{LIrms5ONH$*lS_NvkDG0&*-bd! zjcAhXuUT%cD^spY@EQ&w8@@TvKoo69hvFBeA$ z*AO*Zl;qF>7&b(3LI)KU<@Q|4>GscEhG;vb8`fzN_n_Gq1ZPaAz-+s`2X;r-sf7p} z!JwhYX_3q%@nGlCmc=M;nliaz!EQW32;|naai(G(eZoc8>EZj@qSuO>n$hV9;v-AB zR)Cts1dks9IdhfNa^BueXGse=KaYBe13+KAF*SEzbxp4=Nmq*Af3*8@CNLqwHO$Ol z_D1XtrixUgPQI?#$XEv3Gg%mJLLUPK?LA9KMV$Nu3>>L=d_ZCw==b~+8T}q_v;B79ht}6HUZJA*CMRh%qs&%@=7zn)Fqo&?RU*BQ{&}K zQn`cas2&JRXwzgOaF54zi={KAX`@H;#9nj%YCh$C^4E%I0z##bp`3vg5G<1M`REq5 zB(Je_6GzamXGJRo>^ze(T=H^b)Ew)7=&0UgJ7((qIB|;YChA3=>2v4Fv3{u7(r4o# zcMPX@U}CN4Eca7J2W*;vHm2#Bnw$%T>~lqj>7sm!oMEaRaQRZ{fYX#}mJ&)PJ= zrYmRAH+RrS-P98_MNCAk=Oev-q;b?*fEF-b9RR4D9>yno)k3>Ym?Q>enIA>;dcHiA zchmJzqD~i|g^Cqz_9wZ<2e{VyC~YNP?!yk7*?%+fSGahDFVWH=$(fr}daJQGZk&HIl}mFL-?4Q44fpefOzQ;8qFXNG!&*vV#9 z(3DJ!8{i0kP^!1x&OMPqj;%!emL22w68tUD%4p*`EHVju^YYrNb$6Enm3A1PC;z3# zwihp3ck+@jNs3J>OwB0{0NIe-70{Hi^g$S#WQ`x1lVG`A3Y(x5?gAXI?=G-A#&E%7l;>dp@U@z7QN4wh#jH6f-9U< zcAle8j+_~l^6_7tsJM^K*rqpH)y)Qh{K;`~D zPs<+O?cC2YP}n3J58=D{(5D6*GaRZG?sPe;3Z_XTkyNJi;1wQJxE$9nKrF*U>i!^G zY3_zpHFdf0ot}kGRg3ZG1%)*%ygnk%_hHLKA`yq8d*KtvuJR z_`=J4DjuNSqBw$$W3)KLa?Ihh_Ou4C%A)nXSDUw)SF%%TnWLTcd<=ji=s^R{?zQsW zd6ak<B6oJ^4;Uuw!`uI$AiD*2l7rJ-eLdCS!D z>Lj#LUV}EOkH@hjN5@7rP8w>R@YvQAc7JtGekGtlDqi!8LV-7zs|)lVBeGuY1U44a z@!(y)?GWzU0)Ay9b|sgTko#^KS7&Bf>w5m+a5|L5w7@X4Y)G`3*x1AHJR63+MpJ4? zBx6&zMTwOUzf(62{8pFOdQZnmVo>6gdh)>}y@2ha+ppkpT&|qh<3s20VFWKm(Y=5F z9@RV90)~W*Hs^_zFhGqVS0zn)?SuVe>7FL0GFd)=l?d|otp4rC)!}I+>TV5ZCIWR!#wd6YBq)z83Dv7;NO3{N2!Aqtmr>~{#Q=Zc<|ic z!5j1ggrUpMx*Pv~tuSQ-Ov(8vrmg4CpDX;S9_RN?Qx*jI8{kM$HeHI1SZei)0p&X6 z@zFl9D(LvAeHM^-IGkQjSM)ZG{z)kl5CZ_chw!3pzaIcw5w`K`8)2*xGMs2;ZSnUS zGr&D`q%~*TY+CDJ9G+_SC*n_qU`{Ls)AN1iq?+NFxv=w1fl{(aGzGjv3Z@nk0{6E} z_(CF%b-+F z-f_OCO3Eipw}%c>dGvkwt@>y^#hD2d zTjtF6w+xl*#wp&GZO<~pQ0jjtxx_KUH{aNszq`(M`uE~|H}P87={#r1d8wmEEx*m( z#>Gks`$grF`Zg&F3?2AD<;%94sf5%xY?s1AVQYRG48MY> zQ=iLcRg&R04QUn0XMilTvEKG<$_dz?N10xv*;PnR$hV(**y`DM6YS^ug$Pkh?7nkh z&c_Wz2YZdmxo>c+*I8?ZJ=SP3Xyn_^BfIPc>D9qpBQaHa#}buCl{R*b32{)$Bryk~ zV(JzxpR5#~|N3h59#E7P6SH~7Y10_MW~qw*b+o@)zL44Ca9fgFY2XDqSbz5U_U|89 z^HrcUB#{o3PCOdWT%*PF9OV%3#vY*Nh^S=tJ;Zk09Ixdam@79dSlGq{tOEOYyYx^j zikV+U$tMOXudAG*h4YJPgy$XVeXFy1Hw@6zg#p4O`xro}LG~IDSu8&90eaNvS9!;YzwBgMA1|z8Gz0jq zu?o!T2D6iNC8DsOvaZWNwG_X?~oXjxPNV*nws?*xiPnm0HiMT<& zG_6hK4Q>OZ;|M1NTc-yWxXRJnwpc%DK)HDVhX^7)5Dsb~ZvCip$4{^4KZ}1C;mc;q z#8}a`g^qo$FH`CcFJXGW+Syjiz2!Fo9h1(3qSjN18^@`1=K89?Qw(j~Us7y!0G;B8 zfY3sh-H#{0n0qa&esRq^e_}1w^HFO4d~!zD?|YiflUtcS;!HetElLAQ*L_7&JR5w| z+cj@;wKpXRRnS$(CyDT~x)6%G3nt>GAaZ+7I5% zvo*B5mXOrMR~h)zxAq~A$~>u06P@F^pO2HUHk>rhOS-#T$%QM^d&z-IgLX@Cq3q%M z6@8f5;5U_z@cH(4iS7Bbg35e)I1w=1SOn#C{yePrxEyn6vKM3!j|w<1+PYLzd9<{p zgBNDSB|3k;gl4=br^IRhF)5fLeGJUDTAa=tnDP6>BeR=O!S6%tLg`nLs(Gbh3^cms z5ctwbccm$>EZ!?Duf{<`2}$77DL)&G%)i_7IWr_j-1DtZY*8r{;aXoJ?P@B==h+&o z1RCokKP;k;&m(@nBB?!EetomYay4&XYIun0ma+;4S%9)c_UY}HFV#O)uucVK$%L0W zf3wWZ15@ETdh*H8aqGNg@aea@Xze=iUh7*vGw`uvHhi~=v?iv@=jH7yQ9-#yfW3)} zR2!hvo>sEi`fe#)Y!@mWX{R-0@L~)`<~lzbe9Tifx^S6_hyBvIx^PS04EX% z#Y!(#Uc}uh7e;BnN8G0%kUdiKA+KjY%q{F2Q)2m$J0sg;wiC~SFHkW61`FD6?t23Y zK0uAufk!+dP5euv6JxjTKps~YwB0y)K`UKLRIyaUQvQAaCH1g_?2OTBF!tp&e1GR} zTwOU5Xo{PjboF&=ue}`bqtV-)C@V2sc|C&)o*w{Q{^;=aJ(eEGX%yTlQKnpB{JUKM zlSPrph^I(Dv}n)&+ydMgLKiLx=t#voP0Fxf>tFK8#_J@vdreS8Vo*E#KnzL`IU~ut z9}eZ+f3uqpoAurj+)r}WQu{R0b#10w@}eHwtEMbeZdaWo6{l0*yIQB2Y&p;dE6-iDs5)y$BBG16v>G@!);MG|d5u$<^1PFV z&71~6)C-Z*d1$Htro3DHF7i;H6<-@Z{L{L zE0*t({LUWtE*^RgSdZL&C-aKrc;av^TnSK-szmB5a_d;0X6wkqK|rPDZ&uF6h1V{> zUm4ImU4facS@v=KT{)IXa#g-g84XAkczguudfZOyW7>Z}db1IhMoS^8AT|Tbsf~Q+ zGvY~;oK3mN{!2^-m}lWjy0*MHX(kv(;LRKxGhIh9H;YKRdve8f_4-92bN0|_luLxp zXiXtsWqb~73IVzsj*vOu{vGJgNbmR$wc~KVN?A_PG+tx@H=1s#`8BZ{C5}j_cZ_9L zpI$^FVgT(fpwN^V-oR*!_&VK@#AzDFCDqRnR3NAyCcc!u>ch*B?88fnc8jdOGm5N# zVS~6M^wMYJn=tWl>?cS;Wey@b8V$0`FeP9-_-q!AX&1 zpW&*SuNbhiR+MDX5YYBw9{qewwUVV!50Sq#PLA`ffR|{L@B@40oO>K&$47>nAK<_v zF`+C)U`6wIEqwKOreC?7&A3o8YdaLYwIHT!ed@M_YTQyi<7GLjubmCfWj0gGNpmR3 z#a66}7iB&=IToO>s*4ZAVC|mksdLeTc|b10lzs#_kdRmPFO-9s73r{|Hqvr{ibx00 zvcm6Joz1^4rW&}s5q>yGHg6fT1~E&G43(p0+n(QiBAG@auee!WFJP0*r5ubABf8&Kr8#!)Nt3#fKP;JsK06q9=wF>zGUY| z_*#{^C0GjmjJh`2@pC1@fMjny)LI%omOB=?+eB&v-)AJAMXAFla*yf3-B*b@;wYl% zX#8B#(ZHW|C&5f>-aQffh#=aGy4_t$-<&#YywnQ6?)R20Lk}I5OChQtaC|l(*gu4qNv1)QB#)y zrzN<7&T53B7)2(#u1|Dc3}}T>zUW;p({ebM_2+&-^iM5ojv`I-SC@(s(fsGL)3 zJq5lT7XkFF6aj@l==aoDy*|%HibXC!95g4ftsa1$wh0jPd6cZjWp@uK@-N7h_fdfy zq$v9Yf~qdqM||sK_!1zuz2;e;!EMZDfw;1U_RAgnyXrZbk1(L~6T?)LbrSYz>8Gu8bb;Z)ZHmg;MN;enWD3}5t)&d}FP)3B&nE$I*NJH4hTnXb(r((W)`KKEX{BVh&^CqK z_*H3qPDA6~p(yT($2VV}8o{nJ;PT!xD5M5A$xu=QC%J?luNFd;uI8t9_p~H;fTth^QMTl{3x9nFP_3F4sWmKd z!NF6XfW?yftj_=rzi5XW%s<6--sQ(heOd$j*UEgwyH$EngHPYbeMsyw*=^1d-lCpH&-Ydso&T`dEH+4_+mtVw6-kg)!{i@q*V2r_<}Ca z%Ch&rg@H%eSDtdBPen3FQc9l4gfA}_s^8JeMjZ5FBXkw zqF3NNp;;O232yM829hep_pr%o$AO~8oB7%HDZsmZfzk_=hS3Tl7H`83e0XDeY0!N1 zwv1HF?Klb)z~^IyBTp9d%sG-!{kO)E(mGGDH>IK+Fiz}QX9a6r(McNs-bZsN5F+;a zy<3d`@NxNpeh-e2xjp6Yen@(sdGLhX&H}ISTWhB;UJYFJPfU105nGgovGoG`GsK`y znlDH1hcvQyZr15LuXuNSs(Uxrrc9 z0omFNIMuRRKlA}Ccz;?Mywnt|2f~!z;YIA-iYs#z#kP0%*h`BU9y8=ni$!g%Oj7ip z?)tQoJRi=wgYL4)Yqs6hzUgdsn_8qpa^8^pY-q$SJVS-g!P-n`u{8}LiSDu7#50Y< z_iM2*9H26FC`a@C)>RHt9H-_sJ}79iM$%oa>!yWjhM`nEP^K7e_M-VV-i7;9K18U8Nh|haR+pRXoM=Rc~jg+W*I9As} zF5UCa@W<~@nJELUg2bUGD|PCBkG56v_P2-3LCj%E&(UhAROe)kv^*ealzni!-Ndcm zxoXZFNN7!_$(A8mGOH5UgGd*XH1hq6(!W5uaJAe!%3dN;T+e^&_xTbQbpL3w za}rIB3@Hw#N8D_qVG&KNwFPZ^=xWzVh40PdYMjA^8ZBjchwRve{VVvRYLHp9eRVQW zv6Gne!a+lU{Q$7~Y_)%pc(C(p^`MebqN!q=X#2tDHnCR%h{m_hmX*Zo^g*5>D3=E>%VCka7fwxss0bh6_kx~RRGW=dt zq$fEiun5$ya{i#G8HHE4>%X(i=)APwx2!AEN50=JMD*OZ*mA_vuCwaKnMSYS34jd}vHDR``UR@8Dm_3U>Qss_6Wtq4PZkv{bT$v^MAIdfcYc}efC|+t0r=q|8u99#E7>} z3zP8!&6^`K!KO;vKa1V1htuOwi|{&%fk%8nc^)5^`(g54!%mv>IsjU(bvQ!M`IAxZ zMH&03y0WDzE>hGSYV#nYU!>fy|_yn4A}&g2x!K-*ntvi`N<`ttkuZl1d`tn*T#gtF+HbW0} zRyP1{he_TyMo4thIzBn$dr7X$xV$De)0!kQ(&VV}5a!7Ph^cpNyuBr%Mw5(gmcP3@k* zgO)fK_^c@7Xg27m<>{@zRFKQV;`P%ZYCariDv_@_H4TGSmrJqV6QEeUTT z??jGR(Hc0TGcHK%+VZwN$mF&;{U5dzh$I?L^^0)!gxs04B}FeW30V2?B;p+5{fwtzV|Qg7BvH>BUoKKLurWM$TPObeH;D0w6gVw zE?j4*QvfJJWm&^o&ED;fPX+M6ynQe)bKpKW)ORqO-d7GK?fQBpHh4GSe{r7(6RDi~ zzp44P>zN@mL<>t%9I@=6XAu zzWunEz-hn{k@6zaggpu~zpY+^7H=%U9NcBR7{b!68RhYw!H7YPp?sXRYxUY<~5B_)DmL?W{L6$W9Y1MKF|Lq?*iCs4P6uziyAjcla3h%Jm5R zQt*d)tImHIInNTbKS>?{PU2Z+hw`PZ8_taJd8GTD#papj+l%wuVxwatz9%?vndI0# zNyGWRTL0h1_~J~+Z$!R$VOlI(1|@bnCptOX>y@l9m=4OiVRBdCgeD{h8Vr zL)(eizeW+1wZ!m5nCIA90o;LHmZMM1si~~}fPTMu?#vg!H%U(h2*w9SY{`JODpA&IOMIKFidlsR1_oiPp?a$3t>UVO~(3SrIycTLa>-FDxIy^JGgJi~-#J-6U z_u)sb9)=DUL8m>MeEhDoWhWY6|7fd!?aYN&a3iTPMVyfPa*fe|-1zulM|4H>9{XNp ze;DBSdH%u;kg`k-;YLl1x+ha_R{+CIcDRZ1;d6#$NHfU;OPHPQ<+iV6sqch1Ux42G z$8fnv!K?l^ehqE)rc0Z&=Y79=qO`2bEJ2!s=dv5E#(AC&=1Dn2IcQog(YYEDxv029 za|ST85>1dn^&520SxRove1O=Ol-9}iM~=#b>!cGru6kbfiCV9v#B!dU0%s~o%7JD;Dl0gA|_1a8>IUoAf$h}_3 z2zbQKRd{6s^?XS@g}IxL*ek8C_ombDEVUFAao?`_6rr2fTa*ssxL;Auu=ZKY^_V;7 zM&0vKlo|cL0MsCHO6rX-cJD?l?93p1z46#rGKj8Hi`D^F*K;eh77sAP2$hWR00-5K ziOpHtf4Px#f>>q5CD+%AL_nKZi(50fj>0N4p@|_W(s+-maY6Xfox3#5*+SFkso$o^ zVcF^*FnFY>G+Xkbqdo~UnFEdr^StOw07}poJgI3gfPpULwbFYJYO8jQuGd z9%goC4Gvfx85@Kwcgx25qP7+)>qQ`Ohpe{jSX4SMDXWuW`( znm@iaW{e3CusIOrTygDJCe)vfORJzDxezIn2wm(RjR~6nw zxCJ!XDVJBMR-AFVcS?leEs{`e((%FxiXyUq3*BEJuoO{E}!ry_z#azWU7xT{URt-p)PKk}3YfCF&@ z+dY>9xfx?MA`5bozR%DIppNZT4rEY0uHE?c-JrGWu-2R$33SDvgH$@4hvA&-Z?~ z^QuVrnlBeXCse&Yc{?k7?EN1K7|nGB-1RmwPz$Sns9O^5z+oH5B1Z zwkucQqu)H+S6lX19xXigpfv}+p_knnta8e|>b@~`3avc0rVvi|eG6I@bf*8glJTA_ z*>YP-E!uW#dkLw#hky^n#rT@> zc|Q)JId2t`;^D|x{^7`K(Tc7U$9avt`}H!sogXja@pzjp6XR1ZF-pGFqQHcYG<;w( zkHR16a2VaFVy8Bldvx;dDK}l}PhtAEGX#WD8y1OX5FG8@x6@7~=DO1fC-K;zz4HZ! z_7@?a65d?1wV?hSBi4GWKh;`(R2Ic9Ij4e=U6@au9m9B?$?0~i)a|wiOw}EWJ^|dn zmynL)VhBk2QTv0AjMHU8t<|bC21P|xs@UDyw=WBBWaML6v1T1POGhz~k_g>92`cQ? z!yrqJm@E1`xRJ4^>BV1tXUX?CR1CJu-@BO3nT9mcI{lkRQby2`@60gA+i3>{d$$8H zcA5QZo`SQLNHM3b;hS4!IyJie<<~=TDa02g&wIwIN}r|$)&w;EdV5vu&$r8hc z92X5lik~(Yq3o?b!k>gy#)*2^rAT`ddt>$d%E>ZPK{gKPt?UZ0Yc z?!qu7iyM@6o4%eXQ+8uQhc%IqPpf(==DBOh7hM@6_^9O>(ucKcREArlyQkh&G3;54 z#P*OkwpwGv@Gh}s0R!ZlwUx`8D&2M5aZtlc+fGa+!mA&0mY-1p7d4xpXi)zj?Op3v zQ&$!zOqoh>s-hx3K%rD2h|YlFA!u4hZ~*}n2$7crX+VgPB_TWwp#p7}h?Igs5=gYe z!`ws=kYG@V(t%5X01^_N0EU*D6f+4$7$P9aoTPujJo}}e&X;@6*>|7)_^q?|KAX^y zx28yym0p7cM>Q)dsm}k#ED9)y!lur2WI3n}_X!|{WsVC56Jp$ z>i_!Se@zbi=4pj0o98VF2?ZGoCPJRLf0?`Ts=9hNt9zk;cPW51hxMQ^zb|)Skq(*- zWasIn1+2~FzZ={?zchLXh-sm#1ELSShanRf-we-iwe(nCUbgYNH0AxW`m_?{Fc?xh zn++hpjVh#pu01IqWZECU@|L5RJ4~Yk-&?w-n@>lx&rGLl7eP@_>Ac8L&?*vPCOt>L zSBhDs#>?+qvB@juEdBJXe}TW7{vBG9U=hq?(*s}O`;UGeFAUJC%Q1TIKQ$Wrh~$nq zYb10wOx$Nw;6m5^pa7n5eplBO@E=3_oDu^{Jh_LUk3YII5w|x9GQ&+a zDj)rIhuOdl6cDv1-fvI!lO$D~c2+cfGU5#D-z|=oeUFpBI%j+&yDu8%sA}CbTQi8Y z>7w=JK@}&Z&Tw#cxHZnz0VhwP_jV$;v}4vXrdR2dgS7hTr%#`@l?zkk&+dqm+y8da zlVutNLn1p18xSTs?)Mm6eMf1^uYOHjV|k^sy|cDmIaqF2;(TBggA5LRpqQMDwf9A4 zk7RD5%#PaL=>6u~_cz&JJjNEfX`;$5SEp2a?i>}+J~ebLjK))>i&%_qUXj4|)rLKq zYacK$X)7F6f8I8Noqb7k%BslzdGa5ORwgH?!O`WW4-aCVpG4O{X)ZX7$_@8t?zSNR z@W#oysObpQH;s@xNmA7{l>mvexG{qddUhGSaf`raNFrxTk5ZLGfOM zdSY9TutXE~p=3)o_v|D!FF9n3*nB?v^pys3bn#J~P2Q%R=3MqwFE`#=8dSw+M%H zv52^y=dAs3r%jg069GX+1UHsxP&cu-hW2JAgvt-FYz6w&>1S|sZB_O%B5~wL4E)IG zx|E5pINgM*lttrj3hrU8_P`lHpzlp`JZ*<_C6uk_h{0%iZc9Jqg!JW3r|2QPK=4UsgNJep<05nZ0`Zxg5T zZY!HTbjiKpR^oDX_WGNl!!Rt1Pl`>V;Ge3m<=dPWf{4tq!i^o%7rd*jiU$jJ@y}Ta?F^>iewVZ?Ul&7Vt;U5r3uY=tKqQUwZ!>4$Z|AkqB;6cAb$z)9*^xNUkWuZ zMP@?oDe-H?_7sFHvnys5Yw;X%$)b>a$R7Hb%wx0`rqauc?f!E9t~uYYC`9spghR*B zM4xb>$(+<&K82S%{Ty@w_hwjy`e7W_>-BBpC=#P=t!WgaW2eNcSs`oDIy!Z6_*vFN zu&dcaf@Nu2JY&qs`g((Wt}gqfaO|>5=(H4c>*iQ0i#m{2$A6$WB6y9lzDtc$U9>ZS zpeIOf?ckE=aZSYm*ima-#v{C=>gTkhC11l~7QetG?*A7x{hH46UqXm-0|K;(D#}L- Ql8uZD^bbARe1dTGpMcV}$N&HU literal 0 HcmV?d00001 diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/diagram.png b/apps/web/src/app/(docs)/mintlify-docs/images/diagram.png new file mode 100644 index 0000000000000000000000000000000000000000..4e5cbcb4d0862d2afb20b2b87d51dc2ee845e054 GIT binary patch literal 66214 zcmeFYRa_jw*DX4@%iylT5*&hS7$mp`w-7YAI|QBJ1b252?!gHbT!IA;?rx{a|9;=O z=k31SbMM2Mm;Oz6S9R5{U90zAYxh@WMQIFF5>yZfgz;Vmq6z}R)`LKBUC4;QnLnRY zX+WUog7*+{b$5ecvE$KqQkRL~j-_$p+wZ5pe}A4zk~)xl7QKzj{5%;s5oN6R{fZqcl_N`|OS0JqLjq z1^S)nmWuY$u=@g@wyd4C2^}v@mHN+wm$Rky9s7xb$8Gms*kIsiIlnrH0eSi9^eD@{ z98(AWKR&t*XSl6AwlB#*^6{Tfu%7+j$I*As%@H=P`U*bX&2_Fv`#sQh+^nPNHJuPY zUHd(2cA$d67!v69kbM5BLWRBngmW-HesJs2Spx6k<7Jg!-|0pIqkgVo?Z=nEGkO{t5=0`auQIp>9&`v*9jUCm z*Yj0=k0MW7hEMo&Rfb8tU~p^*$23mtfY;-tH?v-onC(&h>f@1{R>y-RH@9B=%MDUB zcQ9a&x_|(~i_h7?E{@tN69)3B+$t-8nMwKpGgIuZJ{|7d6#1pT;k`z)JI?wO$!id* zSQPit8u6ujY0tBt3^B}E^lCAU@4 zAq5B|pBh+#O_hg7B)fp*zq7h_!MTi%T!4?kO911Hr+mJVcAUy47WSGK9S_v%Jr~{!e3=&s7?(r`dG?#u!PnBly>Z<7J8tPxqbAq@+C7@o7j9k6ZA= z-Q4l;C}04N#;23eyR6|z2t?wr_LoSH=tGa_pCZwAq*cG?M}Ovs@s*XRolGy7=f~A& z7Q27zp#<2bJmHPzdYqC-7fa((z;WlZ!OD{Pn-6Ufv$G$X0e|I&<|IOeW(}Wzf4R9a zSJBs>suHeW^}T1w^xPv(JO!Lp>fa1gxA(pI;8~@@jqAAlyeU5Yc+APXSDX zihet*+G66}NGd*)o#W)VJvbDLvcL8ChLpZ3K_ETYfIncM)zrvUyX>2R{Hu<&JODSra7t$c zuKvG_Ks`f9lw=8jS6ILs0b2q1jhg(QyEc-LC8IHi@0PAo zvwL->3ul69V3V2|uUmev~EN=j$YNYYrYUVS~WVG8JP8#u+F-$)Ju z0(x0F&}(a@gX!}02>iTVm0G|nP4gYaAT^2?Q$0t8qMLK@;X}O9{iN7mQ1%86=Js~B zWW6+uYWTi!$lLjjZ{dUkWv*1YU;qKQnbAE`9FUz)BU^3@iMP|tn(-ChBB+vrja68q z-s<(#urO(16Ck&92btQ_Q6Cqu&x;hLiZDs-g-)`9bY>5wT+%KBM9`~jLp*p-=~%}tysB|?zR0Ber0I{p%`)+g4h$tKn(Hwty-+78S9$S!|=S9xOJJd z>C>>gwJf}WtQSVr*EHy0ZG_UmP)c`MO9f^qCRDIkBPks>gwCDzEZF*L7AMjOy*^+6 zOx{WJ#T8u?Oc&2b#}pn{I1>t!xF z3W;B7cP`H!<5bhRCqz<(d_C$;9Jy0k{S2n`xK`YiDl*XwcGlG_Z>(p6$q<%J z8NN3aG&2=E-BX=w+-}T;kL-S`sF<@ic1v$dn~~r2$rlN!&@7FaGkhyM5W3c z?qdDxu<%uon?vTs?vlQ(55=rte>H3(N9lg=#WH_mCbEz#-?J=q;t{Fu%wd4%9@Rx11ur zM(rt`Nkrik@yxjYX0(8BQSM3p%N5KCvRleh4v5pJ+DPEzA>MmbKpoA zU@g#U*kHnAf@!dz`lUb28dA!eXX?e=;LR8U{$cJ)f5oQx76wGqXu44XIwee2&ZtE% zkq$02IPIxjEFE|M4!@s?DN&sps_07w3?-z`c=^j~@3Y~to^Pw)&Tm|8~_r)|WMoGNYeF+`NW7(fu;QHMivhSBZ+? zkh8qXw=NWqyWXfxr)dzdh(Y(x7c?#IA#Df0)B3B_lP;;bLhBsiz!>BqI+K-b4LJ|x zdTV0Qe@v@3Hg|E#(^e&o>dLzAJ8hCk^(R-ku=ZOxhIK^gMocvj@iQoM=Z>XTXwMMK zPT$Y_@sXk(?Y{qXh$J8iF+c9{brUZQy_OTDgJ~5RazSmdWAz~pRqv6!K=vzuXr%tM zlSFA?Q@vi%f9*>g-dH9&cA>{^z_0uTBOEp-DIoi^K=PA4#1`-G8sVl5llWFX!i->; zI!jlXtiAPy5WMRS_TB?_N(a`!cYPnUiRT^L>&pY8z4#P&7efS|rd?yKEOL-WVf#Xq z9BU~B->nU)I%V_)F1SO+nkqLo0KlDc1kyM(6}BB6kN^OZwpEfF(q1k2wpefL_(C|7 zS+;(R@Q$*(6<@=Fmg_uj2;Ib|6EOE}nwzr55k9W%;Wf{wRvsknBD-;Y|KalUd*tN0SyuqCZnDr}`i9FGVEqd*MIRHM>DxY+g z)Z+rpKV14)J8wpjyT2WA$#wS7`>purFyaWwa^`&59`-qlXw2-mmvz@+p~=tS64_UT zv^705S|qb|HRUui&1uS4a5l>>|9>& zEZOe|{LLE`nPrVYo*B|Q%0f|cdY&dTTk*?EZlOXgyJ0_OiebJ0g56OALcFhkeBw#uYOkN+asepifufV6i5XkJc}ZuvInsU7_wp>i#(`4Zkh_mjQQ zYS~%MX$AV4NGLU%Q`EGsmDDi!^7!g9^4(r#t%VwbnkZ!G7t)>k(NWj{9Pq;E%#m7N zv@GqCT0GS9qtK#{u=9CExW7F}U5BuxUE?msx9XEOd2(gB`=D;NK681NClj!$uR3)} z(8lt%`Jyjt#$+GnVbCpV`W=K827sv53FeUuoZ$LSfqgt8n+r9Zlm4pV>M=>BBuSXr z%Ae8&rDQ~)X%jmsW&?rJC{?$m8I58a>03uQ0&~0^1B;5)1ZdxJ7z;?sgI0O(R{y$} z`%-gZTW-E}$>01*-^Z&-IjCMbZTd?-n&Bgl#A`3aY0A+7IWU`vUF{uck3M)!d+qFv zgYjM!R8YsBksr0BZ@t}0+(l7n+g7v;lQgez?dRpkK*`~jt$8h45m@rVsv)WToA8mO zYBvq$6=&V$-1|%&RwW(I9Dz5eSPX>OIxhDt#VeU1&1%PeCd<18?H&YntPulJIj&Yd z4wwdS2(Gl_gS1s`wi4mKy8q$7b(;ewhra!!N`AAo)05lzYq^re-If5hj~a=bg|BYO zf2VP-SkzgMvHN#2QQJbcCmu4UF1;S2KWJ$!cdF5=Ty7in!c7J#1u6v}qC-NzcY2jd zB!mqPzeL*0@I-+DnG~)`@*4WU&T5}5c%7_B?@Y{>XZAfFS-YT5MqYi;cfG>saNvq9 zq07TeQfCnj@crh_Pd@e7H!QaJwcIzEXeI$y#wQQ4RMC!26uzojKRNXNai+a)+o{j} z=jfx=PbSy$n@?N3OybKRkVRKoxPio_OY?GJCw&Nv7!eIz!A|8Gw(7l*6rlxwY+$5* zknN5`o_P)L!lQjyq6>qvo0`SRnM8H?Pv=LkBUd_fr3ZB%(u@owF|=7qjZi1XE;zvy zIX@(VK^qA70T2zIoJnG=$VYX@Lz7O;6k4a|zA112nX$etQxav?G7LdukgGnrO-ZKs zgYn2%^6|?)u~_@&Qf)rx3YN&b3dJ8mh0)7MS-u*2(F7b2@n}IaQ9N)K|zUe;sGnfs$*T?>==Z=eF4w%elUaU3)7|n!kx$X-oYEY-8d$L|OZBX_O!wqj<%!n)b1U8t=K4UI4zoG0gxM?BZa@6(X z^b53Vj)aB?11`I*Q+@jFo-K(`h(UpbvoX(8lZ1dYKV=i?u1v6s)U{rwAmXBlR*Qm@ zLoD%r4O2rxu%op0vGYA@{SWe|3>KLfc+p)!qbbU*N-eZbe7gA~`s`iU_3B6e`Vq}6 z;?v0ZGC@D|$Fi;HNw(*8c8U{nv{l<@qLXhfOGo1wtz!e#TmD^rK8KqFC*Qd@^TMh5 zGtRoApA@b3HhXZv7=}QQ>fqo`*M5%Q+g-pBlFKf78I;tJO2$0K_{}UA&e!0`F7Np* zU!){P#Fz$)EIYf|dL(>_Z)pk243ae=X5LEik=69G3AcfZQzuO$i$v32{}MA0QlWTM z75h~!5fBwD`6hBdezlLvN0`=^DMo%Fk9zFDWnikH@bS*u?k9rdR; zd|74RTqeC!fBI0Vf*0a~ui;K>T6o8y__Zfw0au^k%xxzs%S=GDzhHM>^9f>RK0OQ)b>zqB+YVVK0v*++w^H;`8O)ry`%th8*VB7EshE{PFBsGZAq|4tBTB5PJAT zzf!!sfd{hDqa?ian5x(rj~pbgch|&BX_vB=ovtGp?eBEzytH zq|IFm6$Uc9=zLmL)Vk^rm}N#yyT4|7uN5`gODOKP9P}JHcKaS}v?5WZ=3h70Q2N|( z&Jq|pvc5MnZT0h+*frs9%yV@59^O*+R_4(IW~`}{sm#gGt1yJ7JPEd9H4LXb?p;dB z_S+n@1C;#!o#OquJ=oLfM4X)*qG*L4@=`H0kN~`BIy0|M(hduxJV>~-Q7=ln<^5XZK#S3IK0*=By{mu3Esrmj~eB|Z54-M6Pzm+2* z-*ZPkX4?5_dzQqqJQs7ykg@B{RBywRMza<1hvUl7pOW?}yH;LGDZuNxlt^f!lII|l zKe@FOG&6alGdE&U!t^6do46P+&3tEl+1c{Jb`hoA@D)qoy(En4YD}U%Ic|vNRv2<5 z3;Uynb+yH9MOsx(wAr5;I{xB=SrZV5tK;t6Cd1oj1(zX)1RNO2ptIy_;czBumb}G1 zU$tY4p<25Xs-6^8xVDy@Nha~*qGG|P`0*pDhz7zwWmget*|Lb>2jRQMEqUrUl-QBV zFPVCurMvq#nDE*#WuF`b`bEu59y2caeoyu1*J$Ci=vwJpEi0C$AJ8duW24WeSoXfj zk((v!u;n;vl4Pcng!er&w|#L-o^afTm;Hr$f89zz=J^&iE_39^N~)Yi+@5%f!eO!K zx9I6n)xS;y-Y8y4lE#NsR`w+tuZKVJ^n4NuKYQR7;$cGlEVm4=la{BgB}5C$X2T!A zHF~I6P&!iRs#nS%G4}!T=ZmEFo>+Lw;IN**SPkJXpsT6%8cmDumJ1Z&_^MU)YLY=% zQ`H+M`~#Te^mWsCMu%aF1dyhfXmd09A11`X#X^Vc54-HTl+xf?wy+;?a!z*~%rhJH zMHuexDv6KH3B#XK>{7=aa}Yxt+9HtX`-~n#_YVIaJ6&6lP(;u(s@yG z#jLxV{0zCqktSAOEwrGK`T-TXyc>a7Q8d(R{2pAE@5ol#W5Q*0nVPm~gie%o7~XW4 zt|xP#bj_}Tx2O0|qIazm1Zhad<^cv6LXnI784GQO=|LiWKq-8(h<2Q3r4b;XY|XOi zNPYrzE_BeOu6($w%j|PGfSR9DTd9$K=h?kd+tW3N*O>ELh;qdtv`7Gp3(zvSGNXK- zvg)>Z1(z>jDTkeE#&sThm-K?_e^w5R;7$y_5b}`BtsZWnI44*evtd}uU)w{&uNaIw zZSY(6-_8?d(JM&3%8h;DxS>Ld!&mMj^@zGYgYuBF2E;#69H8G;)lWaQ+J3gwL3;o7 zRch)bv|afc;*+Llg5ETt3{BeR7{`f)`!}BQ#7T6aE9Ewy1@mz3k&J{d66kf1SO16V z{eMn%M;9`NElt}Yo;7@hTG;;+q2v_w-%_nP?az)X$JhLmbnspz9qznS5=@GvxvH+K zKV6T?cnJ0NMgN2bl^2y{;_QqE4y2eR5Fbrjl#9Ttp6IGpwsD%10# zT5PcBHNi{efpr^grL6X>Je(Sd&~x~F?(on+_1AopHu#Bky%svc{l8x%~qrx zejxyTs65bDVgnqP=S2fV*R^9gXs^mpq7rns@3bPbwK-%`#H6JmDSYXOt9M05i@~=! zRg7K{8P~y)2t0A}BHN{YOyj2i-QvQPn@iDX*r4!V*If6p{EDBO0p)VDM4le^;%-7Q z=PebLn2Yu&Zj#d_C$>RAB;tg?A(MitP}kZkik_(Qqhr*qE| z{~HJK%Z5#z$ym`bT&;1$ebG4&O6X`t9p75Y_x=Rrmw(&PGO=kgIpR$y7#zt=<|_tC z-LWEqW%&2^-`#OupZWPCpcb3PfZBwChJle~Jd(@-`gey6di^x5fk9*U+%;;}xb$6pD z3-Lo%0NHW*Wum78MJn1Juyd9AalE)Hl0MHGGy975+KQ#Ys4e%5xa4jYKJD{Wto zJ9kPXAk*ZcH(gkN4i77=-n{X`vg_1`Mnz$22!by$C0Lph(jRar{JeQUfA(g|_*@T& zL>@2H>KYq|TXDcDgto1RJn|`=2+<;Uj1=yFU_d_z4fVPT6+D_e>m^q*pq>D#=*h~- z_0dKPp@Zhzy?BR)hBoz~(Bh=0Q_5#BTiXfjQOiE7_v7W9Rx1x~=kw$7)-tph$@Xy# z>rym{)bi8)!mrGJTqVfH{c-0&2nMOLh6dg7I|#(*WGl&Vee-7=pqKigii(QDBO?C! zJ7IEW3z>#1SCe~<%YaD3YpA*GC)Ze> z*NWRY&pDBDIL6WviQL%)4?eh`Ca;Oa9P<;^yA|{KVX@!mh>V`(7bX}o@}n_sR5Uag zFL*C_e2=SQPh%d0pxZ8RvRX>WiVcqa03b;uUZK-Gj~iKkWbM<4f|%?Wg}ToyW^Hwv zZMRUqX;gj=@}jc$k_A7a8Eq-1ZQOr#NW#(47x^nFJWC_zAX5I-NJi8kMm_ri?_X@Z z*oau%&yn-D-hA{?q@fPDJ+aD0@&DD1h6ruF`o3-4aKC~|cIgWgI@kk%Dj1Y~h1D(V z=t&75Mrvt4IwWqY!1RU#8+-|fMqn5a>_y%deQP>y6sJ)_^Vx^`u`31U%35ndHK-Oy z411lIAm_|Gu5?;!>Q)xdCPF&qZV$6LA<>5|iFTM0gx8x-ko~YBpt1YCu!W0pwFZ&n z=?nwpo`dY-__emoh0#-dg##?93CBgD+l7rc=LiCJ#93PT+?pNa z9Y0%qygx&~e;GHM&B#jtV^T!pAjkim$oea^B^Y>LgBX!Jx*(ZQ+1n?={W2upmqzY74-w5rF-AoJb=|hbrE&CyOZ1&Kp3XB=z)# z=2Z)7gYc%$v+Ao~L*iRsn0rGI#n@JC*vKz%(V_Z=VMBUu*8;HG$1^$JKInx}38k!m z%jXQ!(0hpF)Vxes6v+s$sA*^#0nA30RmI$vx7V|MK48Cs3SJ137k23R&%aMpx9G5i zIGJ#zR;3snVPB=Jak!;f3q|?HIvh?x&E;c8|sJT!1y1!@sP~i zyP8d_zp{&#^v4tnB`*9tYGG>~a@tbr3lB^1iE4)$&>6C+Hrio(l?X(HoRf{5-6$*L zsclqvO7qQVXdEMR5-ob0F!C7C2p=(^vRZ);a5KevpZ$fcQqmmOD{zblU~;FrmUO~1 znAVcr4f$xyrD-^s;c<8D-W|FO*usE^!L$ZSg;V0@R#FQs77=JEw#^wSQ(&BwfbYXm z)g_&NBI?7h$z%r}7Gk04?WC8_w6=fK70spYOEP4>rbA<@WgufwkQ*Oda0Y{V%n9m` z5%^t$qD@-g?|Gl+oUL$k8G@+1U0>0dhths}2kV;YHl6M7ho`DaM)(z4>;$~WX@h-V ze_O@vxA)Zw3b_0UZ8rRZU9X&$y1bX! zz4K@P{GLmjxf_-Y_ouu~lDaMsS_AA>F4)RkO2jI-Y8!*?x7EO;*u3^4x|ejb8$4%N zT!BEFxD4xfNrpr;iyz_`)nB|49A|Sfg2Ap$FL}>w(iGlJ{=G|wW|sL z&{S~3PnmCD>dXVOuVEuXX*hgrVJDrgvJaH;N$91iJbXmX8aHVfgeg>V_VR$#ME|Ay z1EeAIv()|qdk>b~&L)Jm$t(d?Zf*~|nu>D9#ax+5-f`$FTENOM`nkfQZ+>Cu*zlQX zRw$}+6CLGktDK5Y2a4wEo8HtQqF!dG_<@`@BV(o1@`QJ9?HuqH1$6eWgX``%4djhg z6R6AWr-MrMeZMngR`p==n%o0dNMY7r6=C9%th|@#OX?PR#fO%6d9v3Qh+RX4$Puj= z%qf*jO+T&_Cf?8HBtX6jL|K@?w)~`d=KZBq+I8>zR?Fm&g}Wmz=tMGwk$(m~j>vYD zo;&Nc`1S)f#5{gY*BJM!Y|P1?qPjj$*OIXfXWICaHvZM7*1*h|!jD3U(JRi+EhsfI z!+5rUZ!fiMjR_t<8QA8>S|0w^G-eN4C+xgIh$0uHx1-M$|GsUH`|Y^);!mogDeWgF zLSv#MsYsGww-pa0(8*>T$C(+;9^w_SP#($O*nS^8&qbrC+tAX`%mGG#A}YXtOe!WE za49sp6^`0NDs1qa0p9a3APKdI={*{fRJ7&aiy|9-uPWX*r(uWs63iLtH!KAcB9#(qrXo1UjR$a`LN$cJC59zL zpwUaj&P}99DL!L<7?rRH5-SSjWcr~>GCHR+K)~K}<4d2LbhNqm@g<(wL;5tZhXe@} z^CP5Z>^LDlzixW8dnRaHv9fu767-%sC4AWJr##)-`ep1~E-z0DDx<`{BnP6g3jO=n zKpbpgYule>_&q=bJYjTtcGew;B?1NNxiWJSi<5v@YmC4O_)`QAo=^t1#vXZy&i7gj zQ6SoTCGz~>^sfjihVtPLl8lTD2r!r@V3-5GLcll{_VO$$t1sn*FEyJKFPZNDzmJxh zvP`L!A84PcJpvh2u{#TJTnN*Y-MA@FpUzx!pTIQ@$TKbq#br#uQhL1kPhLe*K=pY{ z{cpC>-p9bUiF4+`cS8Z7ztX$eS$Ki*BSaopxxO)9>UJ=cF9iM$ki;aXQXh*!xUD&+ zzwrpihd{kpo;A>iIp)DCC<+io2fDqe?ZGs?sr_tR);;IEU^z(T<&97vg#g>ydWGj2 zEbz>JWx3Q(T0;0?hXHQv+iWU!l*$VU#Q^kLTYxS;`u~+*!z6ne`E=V^0uzdMJ?Mp9 za=9(k!-Gf3+l>zT@8FQ60VqBR{8+PO6kP{uteB!h ziL6n;h68cQ&)QvZyhi3y(-6b~gC~%I?CUp;Ja*40V!ZdKdrytflG^WN8`iDV7C%Yw z$clSYTIluKJ!hV#)ZGvh`fjywX_s|u3rw@nt!i)?LZgCL*G3<>S!e_A`03}w?8Nn zz|ymCwX++mB@9z$u<7)y$CPA4zUM=EcX0Pk-B&NPaJc(2^(6xc3z#Ol{)ObIY`NU& z-EPW8*WbrKt{%#DjNc^m0RnjhHU_t3I+a<6JM4laMs+kvIv>VxE3VeVMyy{Q=2r7h zXp1Ol#q;uyWCnn*IUF)$RZ`2b=`fY$$^j$Sqz6gP)LgMM3nnK@AzcJ}6H&k0)5xMJ zLD*j+;LMq$ZNBrWV~xroEfXQAQ7TC(T9OaVwW5UxPlT>ss|et%SXRqh!DeGAh(`@$ z6NGn1)*x4}G~AvUe=5@WDG2j)%6Lajl6WWEukEY8k4N1x3K&Ss4?!H?0=eig06-e?rliRV1CF&X9oo+dJ47X9e4gpP6#63 zIjkWFNeau(JS(EA;e!J=7&^2QH2*5-VVcy*nq%~%R!LD{*U7@&a9R7ij|VAdaU=hJ z=jeNpw32Q<7dh)nE5H8eWcmT~btA*aQa;w@Ppv+{sT>m0FK=7JW9D~}Dj4zdN&Xxb z_&zNL7f~9lu(zet3O5370PLH)P(PuwRlz`k#ku4p0AcDtKOdWOWBJ5K)T43jV8mF4 zMC}@nbLF*BuVdL^`8(wUjUx`f6Zd0rf`yG~-gVP}`2}%ejj5CQsL7aa@hv*^f*%S5 z$%S)n-zWMUNKk;hJ-R39A6{(<@+?+y-3LwQz5X4tt`t1*r{SoQXm6D7nzFeVzk$9Z zEqWfMLD~G>d5%0p3AyVcW%mBc2)TcB6w-&UYc)Y_B#!9l*-WGR{2)ThQ!yf0!2*ip zpxV-xzEDv;k0r1|OQxUh0EcF19;8*E4=zv(Rc*UYcO(Rye5FQi6k%AqR)Dw|!Kmm2}X9Rs22{7j$@8V93hVVskAlswhp#AwA|Z zmM<85P4`7MbkSn<(`%GQ+1u zB9+9XpurTBt5uG1*_Be4AX+yUw?5@ngYb1B>Wh)rKfZ@ruly@N{rbhKSco1WW zWisziaOLOoZCci{5hiPr;qM%x74V~1QO0oFx&wjTJ-?!TqnJb zt+0G$1=WzEO@z77B_Y}c+&Fq&)BKOkbyTDA3Z9DE}KSj&Qw@2 z7du0)LyW)bWy_QAMb--{(^yA7E^rUzXTHH7JUFP)U-){lF?togBJQ+wf!;c|+W8BJ z&mYvTw9tCw3K(%b@kR-+sk*j~m8-oIH=2?~m%lWPS=CY~NuTl$T(66BC2BwKtnEmP zYICW%M;zAAXKX!bX>6(Ibn(P@y+IBkEFeGlZRG4VBBwlcz_;R=B?d%Vxlcd<H=8w;Z!eOB&6aOKiT3FF5AxZobR#P*2dU+P@gPpsw6#V7JN9sT? z_4w}uIoFIz!5>c+$7lYyQ4s}I_4lECJj^1HAYVp5xvkmw zc3tjWbf%;znu0iA^v+|K?D;tH%bkxP`1)8QD(4jlMEiPDFEX#*lM#C*kBl(T!2Yy# zi?T*NQ4xvKV)NlI7v&PY_mlPKL#vW)ouz68qXP-HvYMV{y!U{afsoTjZ91g#-gtz4 zk>T$}fE7ZG>vSiZv<}E_CU@ZpvAk!RztmUJ=vxQrnpg1*%{6b7%2)B|LT!fjuQ@Bw z-;J9C$8hb~2c9F-A##qoMTjTYhl_{ES0MW>vM@ni)uyUnpIaw5SsSVv^H7BSR#^23 z<%qEVk=lECHpMOTl1lPk!ck=3NL%HE6Y&l&88tA3s~192>DPSaxr-SZ^mtoYO19ps zZ?!*QXmvoy_eQf4skUfONkG}GT&CWl2ux+3XK~9tC`xeG_cRUW)KcCn4<<3K!!tyd zZ)VP|x|?Bd-CUmHF8s=UR!I0o?+P*Kb9U+lVF#cEqrEJE;u8w2*C6x&Loi77J&qHX ztbu|(3G28`DauDs8*L1mUxxML`wpcW+Zn)HlY#{DLwhMqg{AHVcsvqq28C_!_ZCUJ zlzP!}I>_tq^&*LFx-c|Cbp(en6I`Bmn$91d#xTZ@y>gImmH6hOE;AF>S_+vrcQlZa z^&dJEeP1hTN7tK;MR!>AG`@4B6qd@YWC;Hf&2ByDylnF<0FIRgYHd31EpWGg{emn2 zc|rFvkiL?}W)54&xA6KyCJN1~MW}Nm2 zGrGQbzFo_6=BbhGvS}Q$fm3*F^N7aUf8Y?o!!Q=1ioiI!oBIkC0>rG#=r>+5oNfZ| z=p%ZX95&c(yCFd%iroz&@H!p=TG6*keVkr7&pHPpZ{(kv-6$NFE}s@|-eh#{!u`nj zqD9+yIg=nyR+Df|QqZVq#JRE5h1aNo$dh5u%!~HS_{pVNH5sd0cc0LcHqlc4xo4`1F@TuHN^X~MTn1|qF zv(H~>la&_!w^@{Mx(E&`n|+cZs@;pW!o*xgHD5*M0GuY8Jv3hO@`1_Pp$;lny1AXX%|dBiXc3aCc98+Qel*6qsJ-(I#d5*HB88I{^3 zx_RMG7NMDVnr~%0wpPnCmP^oeaOWP zhi3Pei&xPSn`Pauo7rbp<@L;(T(bR=H2O;ikjI;}>pp7EQGL;h1V5TES*{>cgMtA> za_6v*Ird~LOxA=ReiA7u&iP1SvN9kmL~4+ zs)jYG&`S^U{lg}OHY>f_p;M5$R?_n)laUUxV@|t;$}&JaMzG?qm~mrwdh~) zarF1bu8hoLAfiKVToUG84GeNJKwqKk@j6GG_H(c0N}}Kx;Co`j7)9i^bo`okH#V^& ziuKq`-zr;A+p%vd6GIyw(swxLQki8G;ybNTz=5R)ohL~l4`W~GW%(Jxqt2qO?Rm1C z6^Nk~&Ga+3cPmPuM-|aJ_9;#`peltWQLNww?PvgonRT6;!MyYKJ%HS8qZ0Lz&UuwZ zONXLh9Ovh})0+QL4YD8ouHnO@ymnVsZ23SoQ%9JMCn&5t2UP)>y}v055_Ei8B8qQ z_}8t9apRDM=_npGQFY;ZUyXyd`F9MJ2jW8q*pR9>;x;CN@)<%6gVlVWt{akO3$Z%c zPM5tQk@fmk(lea{%}kf3y<-JTjLp`q4!pPnQRcKqT{8Kbx>=fpzvRwKIIZQvr3Mf1 z4r0A5EABjfiB{jgyUCT0Pq+F&iB*d-S|l68FA6_FYJIb3wA+ z!ZyKn(K=+;kwuoLm-;OBRpS7_d`{Wlz$|#op1{%M#s>CaLGPl3>t8Wt^ZBO zd~I#jU7ka)V;Cn?|hV>6XAbq0$f$DF`ydOnLBc#eoj^H5TO8H zzZs97ENS%G&7Sh2rQ$~X*}PS}!l}`o0i@|60Esi1sLfw2RE-EWDWKX<1n*#G#F2gl zGWcX5gFkdaJdaRE&!K(fMsD>VRorTR~(evcbJ z%{`K~`8W5iA*=Y%q>Y90p(J2VT700C+8@U9nH&E~W^p2-XMa+qUfg%oYZ+&PNw|?C>`|m zpe@R|65FzpBlIDF5r{Y;N=LqyU{;!S?jYIfxNoXu}X|Vg~kYTzQ zddm(11pq7%nfczd>Exc3Y;4vi|BvmNIH}MVLFBV4W#b;)Ei|kA4&RpXzet4M#ipg8 zmgqMsbsXRjUlFtAt9Rf%>qc$OAP6X#Ec)SkteC=Xs?TwAiNTQg$EH^Kf=U#Z%cM`M zR_Goaf_`Eun$EZ2?!3KK7l0x(SB%f45^k8<_~>Vluj-b_>BgTS!h7Ykwx=DV*X*OI z?5@}Ad1Qk=uai~5(VUT?*KgitB4e+J$@A&fDAYGM#%JMY-&ue;3FHA57bzpDTBRuT z`W4*Axum?K_VTe+vG)H}6!V<1*}Ygn_7oz%MGA}gyXX3VtK$5_K@`%$fg146q{d8> zNmflg?Jmm?Z&DRk<;H>OI{|!`E>R~sAe8|Wf|(6ic2xl~a_1ONXil~5i{N?6x__a3 z6fHjcMRs!p=eOzqN=~$40PQ+nG`j4+7C_yVUTy` zZ^wRtz!)rmOS^x45{W`1m*SSO3uw=Ig`ab=qoN$dD|GHcn@XBC;oVGLh$-Fb>nP;t zm$Jd>KhLOwAmcT-=-4%VboNj8lWLZh19QErTg;87^0eN?+cj@- z>(jsAjj{VefJn!__C~+rP^&&Ltk{taz4SHUf??lS0$)OUp-ZxOuM~nCv4i9*5(ntA zun0a_8AO9Vqzb1bhw7y4b=aeoDqDb4lqlZ!TY>GEhahuQ-dLFi>(l!U ziFcgF_5kA=C<_k;Yj?Q0u^z?5hlIaAHtu=C4R{y8 zrkpd-ykf?Qt)=A6?j2P=;All!^dcyb~N2;uIo!Ki!K)cmt;Z=3qpV5n0liu#ZO^(b07l= z2{u|QN@Akg^N9=TM!u;|#6(0r8K z;al20QN~(BBv5=lS^m6;`a))p%zzWo?F$LC98~(@-cIUA0Q#oTr_LeJSqSH>gMmVp zB|iZ!ZC-3$^K8vxIT>Cd2{UD)k&k|5ct79n64A8`YJ<;s#P;eYZKc?Q%mn4m2lQ=u zun3DjlSDWC;^oV90W-{WyBAPMWAeMw(){`XWS-aKB=LzlovHN*lEC(k%dIx^A~ck^ zp7tZIk+$8Z?%6YCpI_x)R7n6w<-2Wm8)D2iSc|x(yTMQTL$@luC}4i5haWV@$}q+6 zap*Bg{I_?!Dl@ zz7Z8(O_9`8ZU5>3R~JLZOBOlsP-D;=7>)Wb4F6vZ)Z*U0ZLsX;2#w~>&zv(fZYj(RqbT^q7BZI>q^Yu;`5JnR{-G2{-ylXrrODSCf}aeB{x0QF-c>uOzc? zY^BjHvot;$VCMWxo}Z`Acv(&lW7)*R<SlC?&@rCQiZR{F{v`+eN91`e;fp*u@;on?dJ44}!t4wKOZ-K13BPoR6hlXxLt{(@aqr9?#J>T6Ti&q&f zS>>C6)O1?G*Yp7|{EtJF+$dp7=1HR(y2lDkwLBWhrip7Uv3V=efQ>u%4-V_>cH#tm zjh!YML?^p@4^!_A==fAcsId**SX)wb@3`Wa=L}@XY`SXyB0}n?dDI#f(MF)rQ5tscZhwjMZ5>6j~VCNU~{k%iI28gw((=pQ{mz&Fre zN%e2hI!+d0UWg5e*%d+Q2RumwPRf(L0G8YzPa-XkCUok=Y2ujHT9l zcW{Vc45kpBy|mm0*3}ajt`S?W*R8Ym`ZpM!2vhf*&87hHM6Fkc)c^c#@lF@0w2;)L z&z|?%Wv-ouqllDN+$D~$B%f!SN0N+=ZqHvv9$=LHC156^x?7pakyA0@@bg9yr<>3; zw_HW|tgLb$qq0OG-oXQa33r^~r9Y zI({%VIZfrviqial(Dl|)RdrF@_n|wb8&p7~LAq0Eq`O4Altvm34I*$r5NV`Kx;q7= z8>B?K1Zm!Nyzl#cp7DL-{fjX;d+oJjuD#cu>$-juv&{|htkWm*#F}FIxBI&VdHxW7 zagfw1s%`ucHrC0X<522b+VY+F;o!*!d{I$C__I5H!WI4E3-6<1k7<~+d3h@?XL8n_ z+8=)wl?KXW!QXu)n|7=2SAT-wz)4b6iyKkpPM_kj#nq3xw}?oAIYGeBgFLo7_?vNIa#uh#Z;UJu!sPA)re(6Lb05k5tl$BZ}&ofO;!|+ItJJW(oL>AQW<63Yf zvu>&RecZoYO?*Bbj>S{72(GAZ>ly)P!Yxdxwf60%{UhwYd1WtU@0TX`$Xu#Tr|!7> zL)-2c#1_@eMP6skIC^wcpNP@}ieGPs=HI4iZ5BWgQ4r#a-08FF!7}dc`XEg%P~^SG z0C}=Sf#@_&0{X8B6{Vwr)7g)TbyJ9Oe@XMG>3>?>w*QlvD3wUVESt6S^cP5;?fyy{ zQ#G1@fpCRR#Oj=gv9rsGS$7kRzmdN+=efwNX{DxG|A6WHwy*S$gDCgMPtXV)9sQjP z<5~{xHdTrR1&?(M{XMrgxhOfkn7*5eixbO~9yWeUSvx$5r?;+Z`r3$mHWOm3x3E_g z=f3{Q*F1@40=7{vO3GObIX!qAeed8TfapRV7O9=p_j^R*Ps`%hHx;f$^?N$Bg)~U` z)pTEmUh40x&%|w!1mSNuW@i;qL~?e-g^R!e6?#QN=RCTNdZ&-dXN|!NSHhp5}^g&JW8GF=GBE z-fgSlo}+Cz{G^6R_T$NIExJO#{H9M5bHD5I{DK9ab1nTJajKRYATH?_PmS}uY!2F7 z90bxBOBYzw)o?`rg_hus3K7FYId5>*obt>WR#(z3XZ|()qRT%nmJ-b457&?~2opk2 z*wkY!EF9Zc-FA59FVw&0Fuj@7Wc6sIMuARBX*$KZu_k`!u#G>7J-V8ve1B~G_~gNc zJUvz0pA)UF_uviCiAB!LUMjtLfZhGPLx{lxH)v0bM9KQCuwzI#w37{pSN{BY^Dsuq zZl)D8n4YNZqKCtIZE5k0J5e!A*c)K?-&gb>|C}?E zx}M@&`~{J_Mr}8!5B?b?Od!Z)P>&bEER?aTOF{%u+P8LWL6AVB^+$odxcn!@)=FON zFaBQFFf3Yah=V&FWbR&`DJb*Z)~=LLX%1#R_gp-pz{#jwp1#K2wRLcjI=*YA`s(Nn z1fL(LPrJZ;?!ADSd$TYmVbsum+*0qmCG;G(%<>U~KyEqRS3lGcJ9RLg>1im8C9<$G zm^PJ72+qZVd}ZgLIlEt-v*E@HR*G5^{d^B13M$Zd%9Qw8vO``!h}M}mg!$5BvRWN_UvJtiEcE{^CxR6<$V~D83A=KkLR9xnGfP&i)z-I}q6(Y%Q||iS zAc0(>Ptr}Crv`_VK)!~6PF9Rty`OO)6G>%#Jxqm+5hdBKh#m;@9ebk(i=+qFU(*4d2vERojIFBB> zv&YE&%z8b=kJ-o-c_xUV7RK;Zy~dju(ygkY893r+G$m*wC2f{ktyxAOoSbj^r9wZ& z(@?XmE{7Vtmkg2hAqBGDBQ$5-s_8V5XLkm%<>b99_MNq(jh762fkoBGxh)f!Mdx&P zeq7%X+pRNfiiUi}>(;o2O=dg5LaZ)n-}lJ?QQvfkqRee9&_8^k7e`oqkQ1+`8~S!e ziBs{g^tFa?s(5L8ZMC%$wqiSQs$wIr_tbO z`DG))mfu&jImIr5s>uc-ot2SN(dQ{NF~9jsW{Bgm_C5S7aGt!)iJwzFMF}sshvy@0 z%q|cJ#+Z`Jj=!O**(3&5rT$G9Q=I=nkLgg{<5d;+?BN}vSu zz1-A+KxADi2XR3@j|>eo%Vln zdaKdTT^V=3nHF98s6BrKqHVw}Bar6i=A)x7JS2$NX=mg&WEctIETq=Q(^0wAkK>HH8zc~f^Jcb>4JdvY-mIqk{1#r`b zsPliem4`a=@@TDBJ5NP!j-*orTo@dIy~42GS#miBcoF(dIqBHgaOxJ{U@iL``cjD* zG6EljDEQ)3DKlz9P1sgV5%Z-uXxO4zd^;+7aWceld^Th9*QbGZ3wURupZ%_EM6UO~ z)&uC<(P|h|e8zoaGbO><_y3;21Q3y{UtOM;o5{`#4s{5Sot+)$^F2MohBqjT2^cH> zqZ(o11;X%yil!DO>FDS{$HEFuP9}w9R{!R7-}g3vJ3a!lU_zVw`!RWn7RMLsaRcBw z7bNfOQdaoiBYYC|Q2`ga1uTOvod6R9a#j`|9Wyh!MPF>s%Ka_grV%vVz^R2eM?S6> z&+iBc(jG&}f3zijueTf{(!F1|5<8Y7zs})*iB)FO#_p6a>AqW9*SWAj2|2p`v$F1g z|HuD$$zx@;>97?Ea4tf>2pG`Dpu#)zRe^tnr7;q(9L38FG?I zxg7oQyWRw@sGQpKL|fVu)_>7xlhdC&J42&3hk23j_E-F3ySqs@Ue`s-<(#e972TUO z<+s{jixa?|bI;#^T>#${Bw&7CL$~40vlW?V0a?>L)Z%vtK|w(qKaKw}PsQ2Ilx5|< z$^g+J$2nd2xQZL}e)ao_Pv%m!4G)N=ZxV`=X!n2a&r925$E>T{NPK7y;>jOivlH09$=f&;w^UI*w%qL|)`wJ8= z1Rdwl2DjqPm?Y4Da51<8Lo;b(*4@$MS?9K>cGD%jz&S>4A5qXpW@|H>py*a=*pQmn z7!C~(sny0VTiYE!Ppwh@@rYpu7xX<1{BTYtw2 z@^sk;pi8qC2kA9aEqgo4N#Urmmd`l*!W3l5i|2981UmDT)694&1gQeU8-d6TN^MZc z&Yml=;dOFS+po;Nx#>{Lp+3Bd4qQ{%HN5uyd5sDR=Pul2@nJ4H%R|Hq&d3XQRIw5= z>1LoCNgBrrU@R*!w85y8+0e6p(A)Sx#bKq^Spbp14fr>BRX=0*F3-hBOtDty@RzH? zj}P3o53dJWzSa(yV)M&<9=7H+pI{sk`1AR9{Tp~QC}E5<`7&LJS+xMm4sI6;oR z(h!IL*X~Rb@4K^_zPRdg5YM8sERmfqwK5N}LE}fb{F%$gLYf>7WdbQ>GMI}q zY*|k?jIzQ5=G{qRYxND?(v!aZ%A<$R<=e~kX?3>1a40FRI9*)(D&WYFX+LL#-L8Qy zSK;@Ms+bagOrk33fBq9)YDij4sph|qh`lj5m{hDc3bQ7&D9EFyhwWBHzg@r3+YyGH zWtUZaX8Y?l431s5vdQGiRkPaguEnmE=>pOK92S?G5=+EBb1%|t<8@v89d;GEhZKGw zK-K!!tpI0nSV9qrk@vS`LqvZ>6UHl)nb~VdUi{f&l%n3e zz{)5uEsZqFwZpg2V9psbFYam5 zl4Ik85q34NrhQhhG=712_~W+j0L6a^0zSuGGsbr)&m+wO}(pV zyw33LfS=@y3~a}(LX;B--{_<6c$BvcZZ*$q-6CpyFG2%7j_IPjz-mCi?Cxbp$jwxg zkq#EEnRLLe&LsxEl=IB7c7os%GUo_uYv7=)MzU$6pA7sdTjE*pPza#h>91Rp$${OH5^>Eej5^0wi;^d5> z%c}qPOE>uCHKm^^X9&0M_e}kI=LpeRcD<^UE!r_U^Mc38WY#Zs?OSSOf(O9kGk8Ds zS#jm70T6l&6mpWpQX~1>pE3xL&prnz*Ht+(`h>*9D6;C`0WTB>2j}E$Id5M6BHz)U%IK*@~ zb&3iq!HW);&zqw6fZh>yL(ow5$GHtqkf9h9Ea2?}$Cm~SZ4=^PvL`48oWt!J#!=Wv5!DSmu55D)gGF$fEgo?Oy;e2@r6L?gP^IUVSK>X`IG@42Om05Z~&~& ztV^<8Fb6|6X=I#dIb;117BWcDS?c1_ofk^=yM1Gh^Bcbe=_q3Dqr$M= zoE%=gCSM*>m8dXYMwIYCLnO6apFOsh8CgfZYY(-X;7s$wsIX_iiP7C{f6qX>9DdrbtKD5~~#f^Z`# z5RZr2PSN19k#7pTop2w(i{JkENr3NL#L%xdWI?9Uv^Tx|F-xQk7UZ4#GfsV9dQf(# z_w*~yZ@+Rbu(R+S?|8TFRD-Y!slX8~C>8B-spegq?VZAPv`&d|i^|t)y+aO&_0}xc zILv~@t>c{6>HG>JG3|Oeh0BY*xv3{aP9#en+){S$# z1R>=nRvg$7ISd?5tB($GEuA<2OYI9Fg+1 z&K^s{`d(EYU}PneNDSq5bw1`lr!*@JHYFy4>hwn8ObSnL zRcB9M8n(P4AT3gOU&l~#dfGYcHRZj@O`)1>Hq+KiuiF}%ezhnH+ef1#8+Byq7=R8v zuf22NBa<3?vq`Ape%44}GDLd*;|av?bfU7j^YW8}h|XBdOqHnumGP}5xtPs+S}Xpz z1nYNX#*3Ok7GF5lB0bym%U2cFy*`P&k0R{~F)%O=>YcW;HaaB3!-9MdGfVe0(J#+B zmiSN~HYIYl-w~bvHnh`n=G-sKdy4)de&aw~?t~e;rYj|z`P>Zc@#AaVIM`$&3LKb; ze7%!(N;vQ4eSxeb{kv%9cp#L!teT6< zcM=kGW33>pwvk>9v%sUV;=_qjV}C3Ny4Nd$eOcbL3Y-_wp=4KP8*6Q zy0$)ZiX`a;C4BK{OtCx+v#Qg|8XNXPNyqiJq{!BI<5E(INV(WzjNHNVw(?#Ig-?VU z+Ri03wR`B~R`-yT6_?V_m*&vYJqHsy>MG)siOE#=h0Z(jRIvCDjvP2&mnwIr&-=fT zKJ2^vTuTz10FYb1Pirpo!8$@%OSKC^dO>cgVf4CV(p#=?m(j7Kx*CzRE;f?O5N$bF z^#kx}D_5UZ`!X22m*$P2PYtn~3W+P(5=rlK!crSCBeN^skv8N{6nYaHoqU9ndT7!g z5_lm6;H~sMwj(bZ*(RuGe&Cdg=Pcm!h;%_GOwYE%eRZ5ERso66@6@DkfcgcxPNN7* zKr&6o(8U6)C1j;k*7tv5aonU^TE{uI) z+OFTnC}%Gu2pw5DRl%?G^~opTnIh(a&}vnO^2_w9i=d%Wr_%~e!cEtycKt(f5n2^B z+m6$7{O|#cBGhqo=)BpWDY~qENuE6^5}VtgJrq!iUz_QEjAX~h;xQWT7LWGMSy%X( zHoefWy#sYk5#v}IrnJ4+Jz8Xa@*MG(vv0=Tb=df9&+)eBLyylnzhUin^+FqLLKoju zJjkar(pkc=d0Mwe(w+t=niO6|Lmtn{9@4wnoU80r&7i^RMYa~yFSVgXu)>uqYR@wQ zr>veqcjE?;DWqdfJVoh-7PemmpO3spjrnW)e!8|IHu{kKFwq_;mH3Az+7rLC=du%g zToTo{eO|lR0)w+fv3J$)N1~k;Z^Vudqb~C;#piA$wri~Kv@wehc%}X3E>X@j4!Lkx zz_~v+d=@?QVXHH3SNBfJ!d|9$1rvu^X-@{w$1@3!wK!yRq)ze<-bXk}-w z505>+d6aDOm58^h+jutR8>Re4Hoegl*;BR5w+FWh81Sk`qb z@a5u{eAa*rnO7lYc&6ZK7zw~jv6-@GnXV~!)u;B`KbrFR-N2$@p+Tc+IbDcJ=(!r% z^2H_97d-R)Q9O%V2BdePZ|?vKY1XHaIv@I{vQ~Fd7?<)ViXyFwQo+3z1wF(?$mWDq$gq^P`<*Y>n~ z`-XnBPfZv*q8M5U#+PMD$LWIIWbxiR^ZB}Gx^D*zC2ZJ-yXWb zlGSbcWvN*-NWX%Rfz~~ATWoaD&|t^%nV9Jiv?IN@No{%eAqP{6kwh#LH!DAt^;^t9 z`!bff9ad2t(^{a8LovSIWeA;j{OtShUntTxOIMx)DCVfe%Li_bHiVsdc!;2l2+1+` za*2BR)2Wvl0h1}$oHnq=WRhZ-5DtO0;1M^Cfkv*-ih=E$qi>yvS-qUBwC>5BRxa%Cd8Zg-I7iZyxEcq-|({!Bjn1fr?Y<1>&-H-?++1mKV3KPvF6yJ1ys94pp6!20>UA12f zes1ETN-bB+{-?a<{>fP=94GuC%Az+)!0U%wbK@kTlf#N(ZoYog_@~~s+8-CSh&C^j zC0!6k3SwjUZ#uh&gd}KC$B@{lPiBg|Z+FrEXT6XYcjMR} z{yLlXPRicpf&oo7<9SO;Ylo-y5(DRYTDjp$n(zIenG5YHgN2xx;bEswFymV5j(MSN zH!gh+O&j#C2jW`(U1nlB(aEtzsmN@){+g`9Ot^6v(yuaqJG|(k&vo>;6%bX#YQ0sl zy=oe(m$qeqN6|OuDb5|*XBV2HIJ8&7h?>b3vLS+{b(0Y|wuvy%z8(v~t6% zhDB5DIlz#zEMMxF&WbcwieI0o3{OecO zctIJF+7~O0;XzrnrH*66&plj504#JeZ^wDp;er4{hb=bFPn5iqyX?evJl;SPr%V%* z;^dxVs8jyYrR$AHVOq1i;zP4GTWzBQ+=e$g$#r9oLi@x*vN;wrI&VujOy&%H z|FE&TEK}xat&b~T6wM$Fh_)*~$Zho)hkziGQYZ4^a4=pb@#0Z$!(90s^99i`5%c}) zCwPqc~h-1C7@Bu5&f*pIuqc)fO{iTcDVQr8j68CyRsr*d$P?)53>8^n^sxFHEhoN09 z6G?QuPwX(KNpfm|2AhB4+J=#zD0|fOZ?{p$by-=86Vt}A-SXwOtFMdPYS9;R-YINo z*z6<6Dt_1;2DD#J9hO$bQ!Fb#4ZU$&5!s^IbsFBm$jZe4^Rs|i#i7*dN!pw747bmh zz608a%-DWK4*LZo5k2!JFTUojhAlX1J#+1%K1xvNpT8(gi5NJcjI(dfu%)t4R7QA7 zDr-8PfKs3{tb%s;XO|Ju{vqQ=;`V1=Ml6%zRlz4 zWYT@E7ayO!V)P~Zyfl5eW9X+5q_s7Yg<43ZZMD_2H*;K~DcNTURTsYku$4aDs~XbBz3K<_NAR1K)Vkp_M)!OnUJhw z6waLCns|MrY4DH@+a4O61i0`F?j@pe(vUC2>j}Lq&GFnC)I!P*7jmgfH_6jHoD?yf z$aiF0T5nn0Qd)};nfyP-e)$AL#Oc+Tdwh{=PkYyrAe5_O+3;HoU9--0<&1A~z+tlC zlfvW+TJsx{{ca|-s^i4pY)JXtW?kjrvtmYgvL+?nQ95k<>0pI_%atLXacaz;+Hb)b zwl8zZ-I4^&gZuRF@AL{&JE-=AbfC?|Z@kzQ^Ah-rSe*Ar%Sd0&=|0htJ38qKqOO_E zpx)9nXY;h-TP}6;H()XD2w!HT@emIw@9!=ydg;wpa2@>HZ2ZgV^4UoB?dNhKw*P1h zkM_YM=8LL9&>qN3mv~AXI220lz9bzRv^QGqQ{1W+Yl_+KVpY=DH*Mj?J2dvBjz8hf zppH!naDC&HlXPh>c9WsmHdij}hr@wdmec?FX=}Q(qUVn|U1Id0zr~^-E)k`*J6WjLFC0#96 zIHOd7tktGypfgvt)Ie2U%+vM2G$F1`O@eX35gfay!tUb!S2}Q?${tuV_MX=>`#j1 zu(EVuQ79_Lsq*78n!)hR83U1V*iPS0Oh0K=x-^r@kGu@h?ByQ%U{8Z0V+W^@zPxap zc2d~__h&RK=gkdIiFI|q7&ka2@)PkR7;JippB+KdlAU3J+6iQ~&sd+iJtLAe!{DIc z%*P7VrOx=NIosl`MY1fi`!juLB)T@0qB>lfSWdYs66r|_JFl4{Hy=$BY|^d6zBzCb+@2-~}z8>=#86l&I^S7Ve!}N;8#FC!8eC zoi^{X{hOeo1}!`z zEb>nZ?91;qZNV1;*;c!0kvP?r=iRwX6G!v$U#%Ms$lOgWT5Y5ZPW3bo2HP#}P(@Z= zIE|#CjTA6uE^#dz)s>kxH1_rX&e%*Rx%pBy31^cY#SOMEFbR37>~HC^@_~t{VBlF4 zwx_48*r2M3RN5&Pszb)ikMFSL8lnQNgoQx*%C?b(mVU*5|; zl(pX@1ZjM7kUgz%&PuDIdlcV0%}=@-7&dMg=Zp4f3;mr7SriV3aG3o#^7*7KKB+$4 zj!ErHPrGSd=w=j!L>KTBl#E`Gq63dOG0?^P?7G_(#Z@CR?VDm3(k-C`3Ws~@D#YAb8l z8N0(_jAo5&s%f?rk7FKm%LxH!rs;lv=7F7Fa&YkQwC*l(bU*JOY5dRnVoPFtvzn(A zFNMip%6yK?(he4Y!3yr@TF-tRF3X>>%>LGWqj57h_u33I7X`b9A|cflqZ+(O zCfmRQB94+18z9>!m41t-W#D<6u5FLGk{A<;05R>&TT8C=6kgFE2+E`I+5V5>syLNo z^)?~b7RRjr`VtY@8-dfLb6KnMhE5QhbJAAHzGQP4)>18V>txzHtv^Kd*dVABBuBFI zhCA*&B+z)+iJ8_`wU}~CWvFx(DA^X)xn?NrL4g&J7v{V<7}rDGKS9s6t+7QZ1bYk5 zW-d`wiJSNr&&OF~gapsdzOzqZffph#-6ZosVrGC|5z z!37O;7chIlfiu@QRh4UX52I#ai2u8aOiLuYIzGX>0aj}9z>?NeowA?ZrrGQjU$h?* z$x4Dyl3*rLmAM^#snvZ#vCx=AOJid_2cpkL*GDvnSt+(*W2AR}8 zEn@^U$YD0nfeewLp--)tz|cO>`Y5~w9B;9}=XfZUFi&_R2oi)?)gAax6<{?TI%XY` z&3tRP7FFPLVHR0n1$Nzj4jtq+mI)p@Pu=}PXackq#`@U@W(8-?k=e6hG|oX}V?V0S zrn6T_U(xMQ*i8_gVM~{Wts`?~XVo~b5`q=+^Xc*TtB<(;X@n}x+@6IdBQ5ud_jR#} zA}^U|83DWnng&r1jcvm$;@J1qTrLVsi#~lQEzlZ#;3tU3!mgoFqVkrIk&a5}wXT>G zdKO;bLuM;V7Dj{bg{wl5)A8B|@5dvvzdfjd4L7{HUs&wP<^(>PX4b zu7`UCq90bhc1(k_Yt8%r||4>a{~8p7p?sd%7$y z(A2;+keX6P6dbh~NYJ+lp4c%ljKY%Z$U&YIqAi{2SN(d}HUPd!FW5wP5HOa(Qalh6 zbb^H#PUIb)N-;KJzHo17)^yh_W5h9N?tpJM^M(xZENMTOU0r}eII0xOd0PMnk8__1FekBhMnO0>{xx0;<%W-o)l!8as{ zx4zJA7$08;OBa(ywZ`*c-2~LP+yM?$ybeo(2xuHojDQ8UB^dmH0CSmxu~5iN0`MPA z&=3P54hQ@vO9P5@|NDq5aE{Wm-nN3DVPK#2&KS{h4}l`X;V|YQ;T%j3KzPCG(C>o> z>WAQPAhPOvS+I4R2q+%xGP^7{zYK9!QE`$3#1eYn1R;(%Shm}z)fQ}p$$;Q4Uap8H zRbSx(?bsV7c$?uGi*>t!h|*+tpgy>;`&$|kuM=U`L6 zwY_1uVGT+-q++yz~_Bi4yFJ7Q)uHOyytt+GlVIEAO`!*$MVlm&GRE% zyuG}~6lB;n(%;VWd-Dh)8SS2K%rv&roz}2$uMhE&PiOZR!P9s^?h>M(?&Yq z2Zm%|mzr>Q{RgtK{)FVZ2A!c_EYniAxkd(c`ky_{#|h8Gq4V^;pGmXhUr?E(r8X7~ zRoLz>ef7m>+~*>b0z|bpXPnsxooc)E^&;$J{T7raKqHeobX)_}NQgIdB{sFj`hGm} zyqsjVVPtU7x}hk!$-*4p$-BZr*j6%lt|EnHxuZuU;e}hj+Bvw;UqCaJT|Gi71%zdw zS3w15%bN+>;;(!PM_(c{8KOs<|EY_a4sRF%8iqpO{6ZkmbLDH*#%?GH$Ye9;*dI)S z`A5Ld)*F%&KeSF5<9c$TU+FQ;_u?CL<-|J7;f*dpBfFd8<8XqLd*w6H=nmu!;Ty*_ z*ZZPXRDPMtwS>l|9BgBmrUleewc_sZT8@0R$2Itju>)N=_R`7yUtO|LvO9Xzb`dU; zhzKI=*X@X9JKAm+MmL9Z5m;Acc`qCrPDh&B0Ce}qlgJ=IM(zOOlV0reMtmHd$n17g zbgh`EnwXsAFq()KF95ccG+#SCIy=+aN7_YO4aE{RDG7we?jH)5v{VC`QgCpVdpH~= z4Rk|rxMLPGCX7|jJ_BQg6uag#8<^#S*d1;=lnIXR!h?o8L{q^pHFj-z7EpNf0Aa>8 z?_T&6o(QR;C%op@JUzF2$)<8d0$R8niQ;ydFBkw^ufL)1Pd#GrS|jtqb$O#}B36&D zKFS3m1`zOK3~QGcfab^)2nqnUn(1(jWaypOXOJucuM9wAwhjlOMKBHEgOmn`;QAN) zEcqx(k4`Jv8OQ{OqmoMR*u4;Wau#kAP* z)7px7`_bgE@*=?QtJG4#*C{9}cWQq-+S1-eOC!O$3f>HGv@`_+h;xY>q+h#3df)UP zkdXzT(Y}L--)^hA%ow%S-=4Q6c+gXD0uc1t`GQj)yb$UAWyZave4ob&J8!>hBdx@j z3AnJWYdG!xp%deY04QnN2DlWcpcF5r*mVi+)YLQ1k4h(wsbF*<*B=G(E%_X_=r+1y zOC(hL`_dGVr|VF4tEArW>8p^*KJ2rx&HWJezWb*V{e(c?`x_ zfWtGc6MF;%gy+w7Q6aMpZ<)j{ejovD1ZZY41Y-kIOzgXJfDiE`CSbr2l%WsE=P zKqw+Z;NZVlDnSM(c)elw<#(sbH6mAkWe73v#y&d58Y3$Jd-Um(;9IMdM)5CzI za9eWw-K^7sjY+^>*JQXxpV^GdK-#S`d>P@DXep+FrZE;SAB6<8w@Y|^?E{Olh*W+* zE)SYdRRUVJfeuw_t~IZDJyv)_nI;O{JOKr7E>5qa1;-{F$PrLS!U@u#de7H6Y{>U* z*AvD#IC>F&-9e@`1kN!8QcQmk_1p{K-JE@g-&RbatgPd5Ruq+y&&ZozF1Hyd_3ANs zdz;wp6F`xuwJ-|HCf(SV;hhCn8Xbguf%q@E80Z4Mlh9ud^dfEG1u!19>c(V$BZC?+ zP{7D+(a6Ct9(zxo*M1}=2F%c}DjsK>0TxZTb$$Iy=r1@&1^7cKNn`7YpUi6NhCB0gR$4roeVaH>|HwyI{<)Q5gM^~*IM)+r%h(r&HAK|q^O1EEl z$@Y>X!mH!5+~2!olM&#EJsjlzP_f?p-C~zE#A}TmluZWbEF+*E9gdnzkT$}HmF%1O z2puqWd1FDF80w)2a~WP4eW&(Eb$U;-BKqfzB6m)ets6_&v9$k^^8f&#^#fgH{fJ+B z`a}h zlo(DRaO}gwprFk^=oVMX4)tI}gk7Zth}OBKnAtkW!D-EuF`N;h51IjY+JfFZG~aJC zBQQu4sX0{5p>`=*J1g#TN6-GPVO6BWNCe`e<->jJ9nP%Vs;FI`ZGuF#fI&mBX39{9 z-yn_^WZX=f?>@9|=onTgy_gm*f&w6#V-;WMUMtd@AG%eiP})^aT-_HDKNhg!&bm}% z%w|%O=??}_W$K9jxmEO!WU-0T!?A-H%c!i%E{iH{S0521&s`k=KFnFEdMO!An$yvd zagbtR%-Or{${RwsGAzG`ypZG&_ZWG?s;Jz=rRV&)E4uFcz)xWzl$Ga1TO1h9Avfo5 zXFn3gM$k{N)$zO)l48)PIBjkUq>|y)goiSz30*eA+grnue7|)Aa2>L~v_O!dFgL?0e@BZKU?$J}V!g z?3ow)Uok88=ofS$JgI;3>it+V_9e%w3@452jL!iXnzY+*OZU}d3My&dvKa=Sv3IYM zU$h-6kXLPO=D-?Y{W)Ol#@o%nNAlH2eNbS@Vj5ebs(uQsv7<7Jw3Jf#XP!M^~|nASrx@CY|G zm~0_55frVJ=coqAhV_aGnx7H<6X1Et4Rp%c^cH;CwR9Nqj?yOh<`YNUmIOzAa$+Cbzif-0k2@Z5>RAspeHlCCDLbwxcWR zdJ^rgg%J?=GBnps*ky!I1R!Xokk0v=f+V7j?} zT(N{qhfj2Ke0X&T{9*UVhZ&806j{)lU3r*!0YB_00_>&&Uy1dB&O=I50PSw!rF!u2 zubHBH$g-za2U816sp!b=Kk}DDIijS@e6N~tzwT{7xX25oP9@~ooyt_(cu{`BCnz;X z;fEi}63r$~td%m-L8f?~+Oo$LA>~h`!(}MRqM8=HwftOG)xkYg-PH4042!09?cX_v z&W3ah;6)9}Ty%8y3Nz}Fi_cGUe7(JH5$a6he#Ma<_aQ2lG5wy`ZYoGrz-MYKsTi3p zw4>4>&d~P3_^}L9)lE;S%*HlQ&4>4Q?v?p#OMd$`_9jO`b{D5FR2XTA)dI^@8yBYH z*4A3WE!eOAS+OVlp$RCc^(DBJrYrvePOPyZ9DSvSsT8=zP;pQ~O!Dyvv$HuS!tnr$ zz>5Lg7<1k#6;L8Ww9@0H7cbgC=Nb+Ka!>Y(idptQ*5nES^JNPvT2Kh(5;& zs5^6nySgYX=SE#wDCreTkAG*q(`=($2hbyT-nwN-vs{i11Xa1Tx7ONTmFuL9zP3!b5MJ%j z6G@!%%#H*T>(7t&z~GbDaoxa%lO4b3Nyz;t!lY?8llEVCmmN;^U$SKcW)`W2*Sn9r z-I*lYf(=O?eIK*1N8hvZ?j_;4sR4gz#u zGMAYZR~k&bfMywtmGJQAr~m)IVGvRyP%49A$AoqJSvZkw$M(b*V5Q))kSl2ZC=y

    9qn}2?j~IT)|6kkHJiRHe zaRPig8D0Q@xBstm`0xK{@!8IETHs`|1A%V)-zn!mfB6xm9XJ^>ROOe;2c1tAWep1l zfm_yJa4V`bj zU_heunCW_jQwv`&YExKJ6?)I$!76=0wvgxkPTw$dxuXo-XRF+L@)WHkal21>f;~a{+vXItrZKob@g_vP1du~{P$cN*$ zo)3XMDT{~$O+MDT*S})YD!eE)CnENh(-h~wCj)@{Mjz9o5_HP4YP2qFm|c`A^o@h$ zT+(j07|uD89qlB(bw!z(6C?4Yju2xe8x?kZVPjl9Q4P5VC2k08D5Xp7-w~cWMM!7r zGERd+aXLL~!yF;CVi&v0l|$8}@Y>*Uvq!}9Vgwvb=lRD^8{lDRt!r999HZJ^W|D`M zP|g~7{=LZZxhP9DPUX=Yf|})g+J5~;_D*2JO0DEx@neTU?{bWPzI{$rCwdqseGMZ{ z*4~xq5k4|W0(BP#OI>f+MB*Ph?bpD|u=vB#*wYKGiy`@^Q_P+(78NCLU<#8)_EPXF z1J_Xt5IVrFYMV&<)#f7)24vI6{)L2yU&rR8r5IC!Lq{(QHOGDk^RzbD08yUalGyW~ zXbM=&DQ&WK;4xXVPT3H{E6=ZhmY#;P1xoFFzec5F{!2Nl_iiP;#J~oqWzifuml*(s zh?9I@e^ro-+sO5L(bHtsO_Jm#39^K^0ssY*<-P)xCL2z!Nkqua(OTflv1WknHw1R# zw&E)fZPdi7v(=EgyLg`UwJ2q;ZllsXYeV=`+ z4M8XgI@BkF|0R>gCu_XJO?F(M_5*@U!j+XelD&q(k*2^y{ z1czs7>jfCqTE2D=P?g-CED9Rc^5V zL{7Yk=FF87|*6??LK-jnX?qz&y7`(xxlrnIOUh}V zj21a64a|^UG?(YJzTcLs%Qs61GcBm$CSRCJDCi9_({lMRE0rr~IRn7Dkbr+n48hrM zU-6T+(x@z5*!fq#9mrf3L5Rpcyis$_Rx#4wtIGSNJJu^h_DNwL{RZdx;>$?eV-KU2 zNO(YUj7Xl8uopd3itS0I-W1SaGP*aXF2W;nH6GjxWtf~R)A%1`Tc(O9t1@Za`UO~) z*4BUozcctSyJV$#-SjDSCixmy09unuR@gxWGK00WPNbORUMwnv$&-aQ?t-(SzTqIeXgE(yoZxuP*z#Y z$+@mo#gq0<`02&~^mkN}dW4EiO65b=#9R9xciNtyS{)?+D~c}HLsTdJ0z0H%v|g6) zwb6GYT9wZK7AAJgS!GoxV4+BxU)0&W|ny zqSBa9vmj$5{cl4rRleaT2WIC?0kZZn(~LNQETGO+nz9fbdmwy|QO75uh<_~@&;Fvfr*hIls1`xi5?N*<-o%hCkTUazr2@=`4^{V zUr|Q)oO}j8aT+~&!}PxC>xB2g<2i!iFIc)iA_<23^Ge(byLo%6MoO6b2}T;GH}QSt zR`bqZymaZ}{-iAK&XWD|L|soKe8UkXOvTv0iCf(+!?N6TXN_HIM|y~J>Mn3R{H<)w z&c0D<@?rZzO3kYM>TbX(R>s@AY~`p_i!d*2x3$-foy z_hVwpsmLe1e4@T{qCb85=*O7M1_wHRd6v!KC?+7@qLWWsozpuBuGa3Hj3e!tpvT0;h#2mdp`CD@{mM>p-51ENbHmN9oP7 z7x?gJ@}V7g;qWW>{j{s-@fAlrJ%<*M66TV6!A{y$5qd%)Lh^M9!Q%+zl4|tFOlV!r zT?hS>71RgaU|8V7v2!bdkZnLRP&|o{c#lQ!UpfKZP&DPest)b#*I!-jRmPfjCl4+x zv_@%LpL%z+w|xuN*6N*$I}is16VYn7_~OaPA<$EP1>GF!|0WWf@}$iC@<*m-aL^Td z;RRc{?mH@FKa!t&@SdV?%=dAxb)s~mR#vX%SE=SDv$}e@_3PV!1l8b6o1=9arYA>d z#~9Nj**#74S9M(nT_PU9>%})ncKNMiu=}dzC^L*=n^sKwH0O(5N89&o`m=L|xO7lm z&MCTzMn$Z_UH@B5$Ev3a$&J8{c`~j=Z&f6tJGJ{`=*nAQoNh({!p7*lrk|!>X#eo{ za%doAi6(w@IJy+2lNf))ZC&0+PawBIJY0}%y^ynj)w-->WCR~ri0HFo{k7x&-pBX^bu@4kPKf}@{eJ_~ZmhXN8(M2BQ zg0TdmO$Rds&?x4ftUF%erJjy7KISHVlm$%y@$|HYZwe%|$)z=c7bjU&Qa5 zYuFn(%)%XIqh%s4?5tN5qL#l^gc?4jkJh7&)ORpw^v4Y=@bnMO@wQo~V??D#J8FLW z7#Z)3&5qh{!?8KXeoRyEb|A&Dy05e3{WcNnX-54}WFvR`7_&eMUyRMQy)!BEGE+VrL!m;p``RdyR1&n7hhHt%F-`Gub zf?F8H_(@woW>{2zqu(1!<0{xa3HpkF5&csDga4Ztt&Ja>_gN?M1L>RF!+Oi-vy1!L z+}<}mxBY~3;wR-4zqi`BdJ1%0>5!rYx##H?T9@)q<@LFaDSQhuEZa@6Ye5=Ml-VZJ zFM60J1T$8;%WYI#s79lAN>8fS-Am(s8*(N{2{(6X-K=-R{$`?JfwOM%(xTwIz0evK zX>7B#+0YoPbp$Rkexaz?r0At7E(-Ti{7Vg*RPs^DgEceWM**c|R-2v*VUlI?1N8#< zu_fpvE=DMl_a^^ZFS%Jx7zfP!tRw9o1aVaB!@T21PG$$0?9~E^+6Xc4*Ld-X8zh z_1lQsiHoHddrNYC#B*@Ey<;z3=@OGGxF{WtTP*;UWJH%I0Q+Bf5&a3*;G+ zkos&U$Zo%*GFSi|~#UG267VG3$&bV`+e0gmO(SU+f(sK`w8WQDEt zBkvOhDITBXCP|J7rh;};PUxA~KmFwg2|B!X2KpHPqy6JVg1f{fjEg8R$HWr9hK`nJ zSg`X&J*V&sUy1^{-QAlzVNcf(e<~TNNnD4kfI173VBBPL3njII8b$s_^OgfF8Bwyy z7TygO5_(3Jj+7=oXr}A+tEqtkdRPPhu1JZ?!g-beTA4>ie*H;G=#S)|p0qX@Q<$6I zbStCJU&%;Ar*7CUoyI=GiL-hH=DEt(3I8FvAklD5jcUrkW`XHew^peip8J_3pl3&i zrY5=a$pvs8nwx!x{g-N0miXoheuh+?mDc6X9)*~CPvj3tm)nw9(W77#F*cJ3&>0UOCxWCcBAY#ps=yU@X}rJp}qVUDJfK<#JJuoeUx zLdUH3U5lM5;(>@|?K^LN+8s>B=s`;kc^RSS!v`a2-s$hkD?NZHAab+4>>~%jEEvpe z!0e=hI>~`!?Vh*Qp6!p0KzQDPz|U^m>~j=@MS@+tWt_{V3H_g(#u$umg5KJJl;k6c zNz#?*(&I}uabZ8;;qv{mi5k;^t7N*L=cN4JYmW=JG1)W0Ti#QbiWbsp+f+>GiW`YAQ)HxAXNlxqlD5BhUFOU8-^pmHqah}!Ye_I6?ahE3XFzmfjN z^z792?lC>3hb_$dzN-a4c)*MKmGdN;xS~(fw`#)suH}tttbl&dfH(A_-IZVBXb*Jm znyTdb59(jrPJs7X_-zVfTw*fp$Pv{Wj)%RZtlYUy%ezp|;ZM_vOISbvz6K=Et!`m= z5mU(?z6}lev!fqtj)ewa8D))Lu{XekAB^VP)dvk|{vIC3p8MXFOdRq;&z=~-B<~?r zoEXE`M6ObhI_EW>tkN&C>@vYTCduQ>x%@k9o@7HYmbs1@a*^%T>xMl#kDd$_bKTq$ zT^gpZ_?hqf3IZvT@RxbVM59}s5(qNH_;dSLD#PT(|BN`?Xj*_;o?g^!rkDSLtxy=j zZ~=xI{#Y6{QeWC!8^hO^QzuK8szh?hhww7;MLDY~9sfBwlY1Q(o8vBUDf1`bArXJs z*r3}Iyv}{Bm7S;Ww(-Gx%akL#p5#qI;4Oz;V4p~T(N5~2b{ra%LH>;Lg#;sL3bgJt zl;G#{>o39x)I1}47X?=+%j@N?vUYr-5S9s@b-EltK!VuTablb8#!Rh+3uizPhxXET0%q=AsWr`KntFgPEWAsl?8haA)1% zY{$#&Q)mRf zq6&LeP{4;AKY79@kn!D293RXIXa~a`Pv=)SFl7JYRvD1Vf4|H)OI3x9`YS|gv6zUO z-_)UxzM}Cgv|si8U-V24sX~AA4_0$+_7Zz7lo9cVKCMeV4oqjZ;!N(ei)RiBNlHH3 z?Tqz^Sxv0gdPhS0HWHr4Uqc>+#A*F67^mp5`Fa8zbF0@#jR`{gWsRM`osa!!-t?ZZ zney98L4+e83~SttJ6TBT-odCR&-B!2Sca+mz$7|E(R#D+n>G2&LGVL!&3aANW`(Lm z0F3IIM=O7%In(G}$Pd7>o;N~{Ma51bqx z0>#f=yWwDqQ-bm(tk0J8l4B8_*3FK$#lIS^JpiTPGX2%b?!1VtP02rMhO1nE?@X+N z7PaK0^!Z~%pb^JS-*i|g`=0N12bQJ*);v$cSp>HqrF=RK!AyURb&IVB=ftR>5#R4& zs>1io{m8`Xu=cjP0_w0wnx`I<_b6)lfAs0=^ETS1A};Bq{`N*Hl#Yq{s*vTKC0=wD{ zx=879_`#^ps?2`BQh(c$TMe|6@@ckp1%~S9O8puGkFG~f2nb8bFLL};>A6=$K-y&^ zVBr+T5AXV*>c3}pZ}g?Vtn$j{{7JHda^Q}zraXvYqV%xcf6LhRz;T#GyJ*|hE2DTV z30AI+a~rL<4nsiDNEnOC6(fUYX|+4ET_E7gr?Hp#SN@Q+B_b+sje_UJV`AR`F8ANxarqabFi>plSx|=V9gro|Jyu z73iuX zNv-`wvWl!{v6FAV!$j$EJqZcw@(Eu0w38=-`;LK_CA*Zk=I$j)fC0HgJ5Bd?ao;w@ z>4JScm^**=jkJn=9oPLerTF$7jEG{jwc4_C|EmJIM;~;hzOhV!OC)>Ve>Zn;N4F{% z-4?PlY>3T8vpvr;=t-|I;Bt=(ClDrcWU#yhhY5ODOUt3j{lFEBQ@=hLo zsoGJCy&$u*x{2yMv_lDodV4He_jNB7g|x>XLzQ^Sy_1LOQgn}sVc?pZ|eB0lt3yHHwCWt%Qo;k8pey8(@_v{`DU4b*vVdHkR)tp5;VMLU_w z%Munm>37Y3X7#C-`{OZwQOO|MfKE(xPrmGz4$ZxUTa6(Ix{I_*g8?HMiRdAa>zfl+SA9ac>i1&)IVD#ChC_Ng(lbG`x zvQ1s|l~8ntlgj+zhuhxC%6pM*tdyE)=;uW4R?cv?0+gUAG7 zyk94#*DFli)W}4W`jdVy76;uj=*sDUb=Jx_Rzt}i)|rAu(bpW3j*#e!;1ryp0eIJDo zd0jM7wS?*Nd~#0)^gash_US?A>?`Lmhr4QNC?+W{Zp|vMnZ!=2e2Y4c5S=ev)L{J` z{ql+{+=~Xk(rvX$nx*XJei+*3agLkucI)Ydg@@W;ww|Gs*7EzuFHa)tMNb_2)%o{O z6geSmsK!@a-PQO_i8S-ts(XmnQtJ;Q#oq4M8N?D_ElXwYII8RkeirIaemE@1onNuktdWAJGOaz7xp+z$BYC)G_s8Wc*zfivIeUJA`JzBQAp4FKo z{96lOAl(2j;3kz46>5ve<(=bs(6hZ+`{#{7dn<7;wmA3MrxH* z*xWL3h0g%qSaCv$J5IW)?|q^!d^C91%;i`xM@{L={kgh&Pmlu;^n*LNPoBEd6cTlH7Gzu^#J{HD`qD12_!Q}acl z=kK*@cAN}ZA|YjmeqaeI+Y^6F z#MADRO=EXjBatT?SMGL;dR?}AnOvPhxSgsGiPYIgVv5fP_5Y!9X{Epmjj)K7m-HhGp!0E0I>y;od|-qv+s z_Kij5-mwFYB$N?szl4VUkrPSrQY?6kAhur|eDA^x?FeWXR(U5)-8`*OF(6s8GRny6 z@-9;eF8$7S_US=Im@8J#Ce|nq3dFQ*tZDpPNd+17FXXuamv4EqWC?b1#^k@g-~&zT zc?v1F7!(-jD2+aNBbKZcxiPXmvxRgbw=8jGcx`0OY?0 z#$5TY4+#m!SO^K2n0-QU5N4{Z=^($9asFd~GOuYM2jUqC-XsfJB785C;09@osQ~nr z*F;C*o-E9w(m*+=M6p8Y{`+ z3>2&|x?JCN+6{$xmOy!Bnn7iv{ei_&7uE$2C!=wRRQv?!=aK^kkNB!0!?|>e-(4_2 z7XB|8c`T(4+tLN=FAWcu`%RB>ex@{sE$~nb&F$ac12Y`!JyZ7k&$I|2RUP-p7jYVb)iU=dw)>4kaK2RTwj#QFKkAG8q zZ2@OnS`!|wM|ihhYFK1rW+myP=*Yo)jiDN!M^smK`CgM)N~on?y}y4oXp4AFj&E_3 z)V&=ty9R!hsdEOF)Om3-s+}!c9BJ^wqgjn_+>uzU>7Y3Gnh0_HsxU1U!FnVlITnGD zjwCg0ju#2=M|}8BwBb=@;9Nd%`7jHOAsm>O_%qy%%M9t0&qnx}QIB-B>`z-JfH{5!5dn)W>}ASX_FXtf9M9hX0_v zI0YjuM{_x?5Qn!v<2l4HQ~(q<6~P1*5i5Iju(RP& z?8msiE_UBHnok3d5|AsI>^$t4YF&mFi=SJD<8{1uDtUvY_-#3hly%GP|yQXzoGZ-%#r_d67VFOdNL_9 zxH21Prr=N6;yv=mo?*K6yHu?|~%a;Ge1AN27tIygmyI~tNaI!9~D|h z(2jml7YG#yzs|XD8%~tUA);>XXd_z%p2d^x7KNmh51Cf`eQ8EL<1>{O^RXb%e>Q2E zNSua8%=s;W)8um18{tA)3Uha+$I9!Cg;NKX z{zR8LXitFkn@89k@262%5|uW4t-R6!3VBS!q_F2gXbax?rU5*Y#y&6 zSszVO5SQ1HtKiwT-OC3tMS`rS;?feJBHOSlnO4)DALJJ*UXee8nogt)d@vKH)SvD+ zU@S`rt6PP0NWx&vG;c%gDpd1?@i$Jdd`_W{v>S;mweYwyuvu}s!>9NZxRe1s6->=C zrI@GH*;OaC_L0anIX)Vm5y^DrVS>7h@s#dh;Hvk&~L&)-BnZQ^qD zzcMh#(l76~E%>(%lzj@MYhI1W$jlrTJ{lcd=Dci|{6c%!QSmN)jj5vArW#NQ%s5bT zETsc5>K+3<{C0n5M}_Vk%jR@+qKw2wzKBhum0#}}ey^(Qz8qyITsS(a@v(J~`^Rr1 zHaA9#Aic2XjV;?SPhXX2*!zbrgk@1XB*A5;_3m1o>g;0T3Iu{9Vv1{IMaM0wb2f{q zDP>uKByIQJ4~XvrhY5_CQ4SST2cQ{%!qdxYtOIz;-SC4X9oa8=_d|S zQP%mMir5M$fPP{jQz>COB)c;p_9-PHHf?_MqO1k22>!=Y>J`3O*>0)ldvpswO_*<* zY)wgFaF)GztmDzIaiUzJYd%oJX;>8DjVo%I2P+P*#r)Lli2Pd7b`%plg((rvMPqX( znz*f%KPLH%BMSk+#V|ctYsN(D%*YuQL*Z7@vur%p zDbbbhY$RV2TZ#6`>1UAwPV6-i1XTH96|>`>m>Jpq98YYhAJ zZ`9p?#CuYAcgPbMyW-zeCxwf`Y5m1cxDt1cmSnheyy>uMDR9|HdNh*Wzu%=!S8i=w zoDb4Ieh^%UJ?UoIk#R(2Y80p2`4CD~{(1K2>8_~@srtA^qT@5ZID56jwy1#iUv%Oh zpox<}lRCT+3P(TG&nVMX3YBdBFG&fZ)gOc~O1=J-vxvDai1tOfO3@Vcoj4iRRfb*C zYzRH8P)>nB&6*}S+Lq()h6W4sk!lZ`Sp|YlKD=HkGC|DS+eA@Y&${*+ZCTI0`>~k0F*+?n^|Rh|P068ID}}zdMhQ#8~>P`Gv0I)3OJS+?Nn1Q|={= zw)|-FWikjuzaA^(f9b_?+{NK|3wOXH_+W%DOBV80rh3CaFXKaEjbWa)quH8_Ok#U)eu%q%Vp`+XB($Rx$rXCgK}w9{*WXfK=3Z^N8NU#m z?RiyDy9{26l7X*ZB@)0b!PDON{l(^d!g&0GhuARY&B0t0YQt37gg1G#2_^hR;r&5? z7P$d7uKjWp9b2C$?%9Sgz2_D6P50>shCg8e{dTSly>A67_m|S|Op!wEdLOxjs!eqB z8kiR?^5(n*-L}@GaM45AEQ?_4HYXS;ME|hlpY4CP^#?%Wu9YUw(2bGftZgr|B^9B5 z2N|NDI%EcI`$O$(?_%zD(l^E~Z3u!V5$Q}00TI^#w+0-RDiM+&{{g5o1bn#@}7Gj_h7>nkh*A6_&Rt0F>pgVeszQf0k$ z{F>SE?}fNKU!qbUco-iFYsKLiNY(91vQ;HRh6jRmhF+~;=6Z5ps<_*+N8%|bSU0{aI`U+y#%X#TwBFxWNB zvkmiA5w1a^E$abUO5l)Vcb`4!iJ8BX*vvrs{^*!=@9xjx&2?&r61O`_=tYS`TC8uY zb3A?BAmfj(fSKoj@$tc(3BBLa3bKwNdX?nZlHj&#gNZ1!`q@qA&6sdfIdRFya{|=a z+^4*A>jrx4A4ZY?!ah_?-1gFkGA!sUMz&{b(suZ8?oY1B+gEBctZKsN(BSCo>^aqKx2T&wZpO6G%YPcLI= z>AcCk>>5Hvk4gTvk7AgK1MJiJ;jdhz(0eccAzj>!JSwcwi+20b!Eu9hm|T(f+fX~q z9n7~)^4!+LKGAyDfD&_Iq9pJMkHt81X;Id9H82Bs$Ci||{UrAvMoJGG^`X?dB}7Gr zpP+HB$I-B$X4R+1prNilIEtt6d~@2sx(GJa;jVRPdqkmji52CY{U}ilNB2a{`8@3? zj&KCb89A1DSX^?FC7nW)6*0}XGs3penk2z)f!2|jOT%bQz>=z(Gp7H3hHkd2X_n0G zy39upMwUGxBf7M@tLk$g4(+*e#Xwy66wH>vm!i}Z-*GGn6qfnrYTF&&1gUE*^;m*$ ze2)9&=Otc-(hDYq3Cz*wKZ&CsZvb4{X3JY>_Cj$HL8o`TA^5l6&tYeK^nb@k!z*w_ z7*VvT)t>eR>MzO?4;i#+2ypch7rWmO%fmv*DfbOmjKj8Eh;6=@_mCjqsDI0=?v81g zMqB7G4HWJYSyE+>+sCmJI;>$_kI}WQ{+)+$bJmdS5rQ>ySU8JqGn&roYH^@;T5>p_ z9ESR+kStaAgT7v7~pN$0zZN*kz?=b&`+nD0a8Gxq!0+oez4Uo~?ssaOY_Q{ApRw{e1%)`7C`*6yA21 zXd5hF*JNbGzmMQz)T^ireJu8@C2Z;POCQTi@pU7wmseSQ1B=Rs zPK&Cah&mc=R)gvuLUCcC8?fwtxtMT{^R29P!aqWg-W-(|m%yCdKV?xBL0LzvDC?Kx zR6Xq4Uw|-JAdOKCmx#T_i-f&1d zailFX29+QJI$mxGdzvW-)Yx|JP5pF>%}-4$hv4SW!IIxb4TE=b5m86hcw8k@sx@9A ze5{j9hr(?WdLof;1>X96mVTFv&;Ldme7+YEJiLX5!-hTQI)XZX6C1P~a98p9>6a3k zbsH+0Z6~uYE!HlTW4zd+FTi&?Ew3gNWm}fR3id7)$52kv8=$9lX|TvHRTQU)Px2Nqs0;r80cxDVJ=;^;gBJH@S@ybj9Jk+YGwcItz93paiB{I< z>?Tcor4~c~6oJ`aC`FTVGrYgD`X1#+Sy+kTKplz-yW?u{eVLUD8Ust%!~q4%%}F|c z&W}kgH5}m_SpObLdX4%hm`BNO4%yGas?>i;I0;dgoeYHzRa{wTSmL~o^sQ81?t7TZ z_-{a>yCdDjM(3Rm3A8zq`xYjEH^D+Z=|CuvQk=Qu6HQHRtm5K$q4;~G&ZqbVBt`-& z(XLyc{dQK83IH`g?x})D^kP%|roJY`4|bqatg z3l8Je3dk!}9Ne@dgP@45Vly5Ei^ zU6>x4rgS;WjMF-Sv`5qUXM4hyt@Wdx1CK_&;U_p*eRKr@4A&HM3VZjKM*=ASdF1hE zBaeP9PF0G0OLM#_9<9lxqd*;C=nOr9sd3#ScI5<5Yw@th^jK8aU;>6e4XGm~}a+ z3X#*5#iy7)BpO+2Az7CpOd2hQhIZZh!T_n8SbdywdI*xy4!qBew z*`5d7jdDS=qeks8t@<97ypxaOP`}%?KWsKU&SCF1!Mys|h1@s_us%z1GeyZ{OiLv8 zUI$qwXLsPTwKtJhRD@mpSMOf4d4btok;PV|YQCxk0b_(hmeOc)d)iuLXuMs~0$H z#V#o+0r|gO`T6E%lGZ|Sv)!5gFz3B7C=i*~KE;abyx!6xKx6G(54uQHaPT|bHZRn- z$Evr||EiC@Z0Hv0kSbic?%($lm zb&h2U)VLg|oKQjt={JcL3a#>cIRg1>7`%Lce!c6MXT<_qjJ;33iSTiILcgfZ_5nX! z?dAXZLli4`33kH-1m47Bza|KYuW&!o@hk@tHQA!LzHKkkW8PhT=wmy4Qx}N;rS9g& zLoFk2fA*b#fB<3{a6VK;2TqH)q&fm1>O=qV52g!XBFM;M;T!E%r&tvsh<-AwUPP78 ziM7Y>PxHW8G$JDXPddvSCwYz=G2c&{?>J8+(zGFK;Nd|BvIg?%Z>oWVsCZ?iYK!gd zH^|_=8$WQ`_bPq;-^Y%JXe&N|R?XYyaUZm+z43ue_cg){w~I|lF76iseAZrj6Jh{} z@66%xed!{9hI)M-uZ_#fLQAwH6u#p#JIBCO_I`|gyGMUMHYeZAetW=K^Lv9iIc@^5 zak%598|L9*Z>ST_alx`o1;@=8fz!@ace+jV*MI1BwP1?`E9<+B@z-Of>c!g)VC2a$ z+B}*2movZEFTxM+KH9&^3NTedCKAHRX5RZ6zcOB?&0g-b4CO zg6gtSGzUaTZ3qO2fK=k}Z(IO_ab%;leLrGNE^rh_LzVlBN)%|;fe+v%xO`EpOh7tR zV6Zp`@Q50?V%nl0sEQhDu~AaG;ZWs;8z~XPXhH>mKV#mrw)$qW)Jt%=0ZkB`0jpHf znfNa=%t;S+pif0}HXUmqbObaFdN{a0P|P;U5cVAim)-kh`gfpQ) zIOe1TKm}%7TYFA2goKpBqNh`JjvHY3NT40U_N-HrE+r)pb_Q~FAP!2^kdts$`}f4= za2El#C%qZQRzj-9MK0*crWNaIS=>4;{Fd4i{~REK2LT4dB`x5?gZEz{zyU{q7(pk_JIb_A3o=n)T7Y&GB<~Vu3^>X(>r@~-88$!| zoa28#hljIZ|EmPJ%s?vb?b(|mL1T`384I)MScO~U0ZhFIRyzZN1lKa`rKOGzV37pk zop1v47Xc~M*xrMz>b#+*Eg*T#i@ZR*S=M4k%*XZXdTqgbL;jH!jLC9p8LTzGb$84T z2MTEwYC!ICwoxi6x10Dvn4^la3~c&M*pu4;H%0+C!JR3>n3FcxO%~?DESL&-K}!T~ z_tj@|S($xciw2~qEQ0%XD#|o^V0`Ad!1pp(a^C^d8g`Rmis?_toLK^EfaEI%P}i7& zjWU83s8`u|C*%*Ib>wqGFR(%*7$JrAH|*cELKic}AcE4rs}PGRB&s4k=zSw=3PjhD zt&@{a)w~gv7t(AsqiWY!_5aA9*~I07W`B&4g;PgBn9l66VaW7)@DfSzSdF_r$@(GT ziDxThEb@L2Chg#9>7pZ6GrsVryu<|{SrS8tOoPv6xc&jI?BZi-JDRPcVJ%p7a!~`u z-Yu2bK9?}BD&4|s}I7xzx~Cn$$F66 zBG=N1z@vFFS3|zJY%poP2Xa5G@lZh2KeFz2Kb;<<&eI&o;X!++g28);hS^t<>ALW8 z??ip*I>DwJ!{%*CAslZyGj}@A%IA8@)I|(0Tg{INs@%AA9DVj942Ac%+u#?xqlMAQ z^XU1XZhA?$DDylnGr8q*Y~5deSo1qu&gV9iKocT+#|jpqZ-ir~Nunihk;Aq6i&U>_ zeGTkOlLXVd0c#OEK*vR1?0ufc%*B=UlFa=gdJ$Xk=z@8liIktF&(nw3no9i^1b^#= zt3ykaC-Q@N)qjOZp}>U{*Z>*4-uI|(1XOuVt`$?ECsN_gX;#x~8Ub(S zwG%4dCCDvnYHV0DDzRAx@5uJ6AKA(-a=Z{JBLIYZE0}rYm|aT3u^f5aoDEr>zq;e{ zk6Qpk;?2kO8n3L&`|blq$A*4Ot~YrLHANsntf1c*G-e<08Fi#q8mTEi)@qo;QeIiC zAGuql`C<*vft;m9_X|U}|6#SehuupX{ynYS^N-zK|BBt(Z;ex811fZ(fk{DY99va1+@8OK!7|u+ed&az<|9vtd0-aU7b=r%(RCsN= zcpBrX^v%G4^v4$hmtu(Dax*0)IAVadNJ)3Yw}Xrk?|*=&P|O8!)Mpbraz%b;6I_%gRq`C#vLX zdP~S}m6-|>IBLMMS>PPMw-Wvhkzte_BH7b2(KicPxdfbYIpX~lSqZKmzyxs=)uuE9 zr_N|ALGtY4uRkKIf%vx-$_mKdbP8wtM!@j_jOH9bjtm)X=4x|EM{VKS5SOI13(-aM z(!-SD;1TVdxNWrQn0LdNuBH?If~ak#73+3u_joN`y&2A=Y@i4wCg4TH31eBAIfBlBB)Nsk29a> z_Z{z2)UYYFGdclN{~Dl)z<$$0bL&M&8mFL4vwEvu#Y+f1mmazDr*}hZ5oneWV2Em| z@d$Gx@;AunHJ!bM`r~=Hvi{i#?==^2$mrvRtFM(XOya2JBYk+_Oz8nmTbWd@cc6~9 zaieD&@rt^ere9h=Upwpug&M|?`dK{2^|zxkmy(D9iygkru8 zk#pq#4^cF|b4!45KA;AGe@Ulu1&_aUc^?Z`D{|YGFFkU@@KH1OC&R#BbTc|`a$LWO zd!zhoA6-~iik?jys>;~c*qJ?iqee}`;ESSUR>UD+$05g1jso0NB4_3v`AvbN0th0? zWvi&hWASUhntD892{moVWa3Jd#`iiGE7Z$Aqc7I&wDZcmuTXL8pu@H|M6}#{Rxai16C?NHisQpgZ?x<87XYqy3?ihjj ztnUu_tKl2n=m!ZL=LHpkk!oPc{z~M$?_f|~2Y-&~2?i?k^B+pWI&^cjpD z-ExyuFv2IIgEwJ-mc@){JnUeTQ`qF)u21snnp??-i=vK6fD&n6N$ zsK6~@i#nDkfmN`>m+96`uVPrPbZZGWo|w z#BloC&k4bI>vwweS5LuUV^ke0bG}~`7|LAlSmQ9wJ?kX6+^Y-SVi0ho-TA+7F~i4z zjl0tA+cE#<`VoY+w25e_6T@lmq>Nd?p-y_QW5^cb+2Y>o-RCQmG&>p{cSJHG=s zv!LvS!Xx{BOw3^bDP{$VKN}+Gfy(vdB=SF`Pj6ZI!&0U#pFVHm-}sefey-Ip-$VRn zE)p0`TnhziYkQ8T%u`CB-q;>;2l)-K|02auE;o@oA?e|IM@bY-EmMlwv(TIb-h|Sz z+RG6=DhG%;K9-(X^n@mh^^E&Yutbfd*XR$bpL%WrU1PNoGFuLwy3Z(R^j5 zO$`lYr^w@bCZJQGv1Wp)mMKW4?UJ^Y*!2}YO z9#ooVc_u@#VD^y$9O>Gg_#Q9s9bsGomo#?N01GrMIrsVoGAZjadtO~YgD**G2h z&tykKxI8{lU~#^+pK*=>6}X723zGxAn_Wm!11uV_;Wf?+NjP$7^6m#Rw2>|V8r~sS zadsqI++vDsp$iX|(n)X$04>A?Zx=oWKGXxZIaZ zK}cr%xUm&0)a3iZA2vl3;T+(P2YNlM%KFBlO_`=f08|9Xf`P#|;wduO>bLQJt_dR@ z0B@!eOgPoCQ>H}&H6(s}lX|^)f1aXLmv|px0&G(YR=~}I>hR znf(DVXBNPAO(-yJqrkScT!Ch(L$L`rjwF~6zWQ4WAyg5t32o8-B4e+ni9lWQ=ZS;) z0^AMQiwhBr4CQbHAdX`k#f35xa19V42Cz(WP47;8fY2W?i*7O1o2*?_i$5-S#au>- zp#Xzc4%`F({X^!m{C|b^;Djwti|zG&eG7yt@f8fv5>KRK#bC8yEXO4T=|99+kwr2( z)dY|P=RmRr5<3un5()4gl*9!T*^(arWH9{)xOyDdrOxD?c8ki${)cg(%;FoskgUas zj{;BiDgeiyQ0FyaB1qA7-#tKt#{~cZT&8)13yQS#@6#-G8ht+rSjt1+WRLE;yzPYp zR47wJI*??l{!t)_V#B}+Y=RJoTLsw|}#UxkBrf!hq1Ei{YbZ$Ht{yY(~F7%dUJ1nOu3(f4UG?K43&2CbGb zO9NzEAtacSn!qGj-u(+Yu&@gJ<){LfvW>>h@PBevt9@a zgJd(H{X3GS9_LGc+K0sK4sL>ph6XY-2$4_#+x>#T^e;5pi-2;r>WlIwehz`+2(Pv_YHJVHbWNI|*2{%HVb0gk;Yd9zP*$_fbI8U4=* zGXGZAKH0E9EfIjLE$Dy>=8>*Ww}QFFNoa#SO?GVtwi9}z02dMfiy#0d6B|%=^XqS- z4Go_FyoYM7au%*xqUQ6m3R70&l7BL{ML3uiSOR@fOWFp)xy&Q%>C;qj4f0|+nnkD< zFy2A2kVTRPxNI~0;>~O;?YtfRh`z;S@DSm~VY52Cwt>^qT}VbvOS=h_!-ut*0*vG6 z{h$2?Yn00%GTEMYHT|Q#aaSO0=|eyO3D|h@Gu7_J3eYW)O-W(uO*iuQ3jj_Gdshcs z0{g1tr7)eFbvx8-HZb5UJhHNu6pk|M)ZOGr!t>%w@<16t3(vY_IxSV8LfRklIz^MlvP zH-9K*%*iAOo}!|nQf;%Cy$Phb@5Ar7mjt<6;QyT79esjsKZjjkCx5#jH|Yvw+vs>s zd4mQudEF3=Wt~h5hgfJ=XxC%O$V5VcvV9NxfIRVX&$}NxAVH2hx=vm{o@@q>pAXS> z^h2Vz0)QiM@O@f>1%vxT05od3dSe{OV+&-gY<~ifLhx?XNQ&P5fS)%pnskaA9_C~! z1Wp5v!wA;e6WuWS5kjY`pl}^nSML6=r7#_kKU$0P-hNWY4x@ZBf=E8W7_*3<&*e zzEEq94g&yu9T4Pvq3!!eR{d5mo6iCI#p;=_bPEEevIO9ApzL-_1&|#Kfl6InT_K>k z^V*s3oxt;Xm`L#aQD3PVQ~b||Y5Z9RwIT9$B{DfVnG0N?Bmx`PeTh4sR?n(kEUl_v*)S(R1N|kM zjwC~Yd~a*BH|{##+T3_BF%gAduD^QUZ-jyTf$1KB3_$^@DH(YR3j*f10|GVWv4@6w z=SRV|i-d!vx^vvp?nB#Qg&(%DPnanwk$Sc+K;3tA|1(7GxUh+qA!Xi06EKl=i2!u? z|Me2r&a+fmnTiF_^2gUdz%v-Dp&$DM*KFT!7~xuM233JrRWA}EaBR0djyV_!yyzgq zAgXh14N~yE)fb+8k!oE(&WQReb9s)mCz$2+*j>7M;1dj<0n7n?B%C(z$VO8Sk=j*+lxI>A2yfYliTaQz}k)cP7SDi?&w0;kU=-p6qB;mS4O z0hAM@$R;VD>G<%67)sWW*mBp0?Wzf3szBV3>Uv)Bx#>53 z_+v?T%M?hMW=vopLYmyBKIp5!P7^}lxlpcJn^M%E#7;cteldgOEfUPNF;wU~QWs?E za_<71h6Z1kV`a7fr@6C?s`BmD{Q{&*x?8#yjdYiaARQ6{(kUR_p_G7xpmdjnw19-P zzyj$;Qo1|#z5Ki1z27~~9^-sE!Rc@f>3- zncZ~W4|>Bu#qSD~<{ZX~SFx+eWgq_NGa3>9zF1zdeNo{lCD34H{{nWl1{{nolRUB5r%=dc1nKlDEZ7YS@&?=ICfx5{P zsQ*_ZaY_dcUE_BW zx0~HZYIC2_Vd2y2%~Lqc%ixtjjtaaTe5UGx?z4N2<;PxlkC}86qJe3-V(~}+-8kF5 zEnY0Qc6|vM+e0-ZHr2);TqjWC@ng9dfd)mF8mq{q-YvZN66@{+3~HdD(#yzM`8G?2&_?$=CRmy<7r z$AP1a02?hizNJe&O{=Y89Ic!+`#k&rhu<#~_MU|erjY?RRWU{&#g5`k_w8$5HHIt% z7w9)c*w8lvPr#8RLXZ!Z45*7Ur^J&4Q@#X#w8P`uX z3R*v0!@xQ|6#$;e$JU`WZAF^6x+Yzx$;<`~?h^QQHU*&vp%=Q8Ot9Grfy@NTM}rDl zA#v@5__@$6Yp2G9lLv4IPvtW<(2BK+hrcaI8^B;LlF;$tlPrc;(GH~P27!0jQ2*|j zS!f^=m*>9o;@v$0!9C7U<>q@PD9hi^+xNh_+YaEhnyN(szkClNgWN_uIhZ zk^}eoMXKtnooVD*Chp$a7m`212+aIkilUnJiWvVmHc3T^kO@ImxA?mhL8};2l)@7< z@zH=FG4^S0bk9n3kgOmxHM9wFF1qLIWR46x5>ckBS-;GYBZ@`nBFj;w>ZA_Km^&f9 zh>&tr>a0!B=o+?y|NO%7VlUxfo?L{Kg_3TosZussY!;6u$e7|4?ZR=f%Bvz^h!|fc zvbrq7ba=-!O^7YfRz-*XCnUBK=B~cSiMxW^ID8Cx^W%h>`UZ1tPyL$jkx_6IdRx-2 zoHS7j88(+yNH}zdE)>25cX0H^zl5Te_4E=cg)Z`@!#;Ll=U*Z41=QN-X3JPnT^)}y zhKo{o9|_0{^h9893~wO*p8{0i%*hd+f#31Z7fyn$@eBQ&Hehtu#|4sOV3SWDtw`;8 zZ>HAX>;!c32tefO!F}-U;dAgN%&s(16Mcdxy#t{4VM7wjbj|ov8X0jKV^=f02ZpYqsDJ}x}qPMI#Cq&y*m&-f=e2rB>tDcxPp^LFl~#CU)2ffWME`K3)UwmS-+#wrrsc^l>4L% z{vN+9>F7v3>B&*e`*vP?PT3m+OPC}}0?OB4?AYV(6<8PS)kF7FV!svO#hhJgF?OL` z4YfMwQd=Oe;r*n}1rO-EvV=T;^%#ZQz198OS_353PT^qwrR%5N?#wmP(+mgM<#d@3)kErWCR~+S4eURT z7G7m~I`aJJonA+aA7GJyg{8krHQV6c(Qfox(VeRD>#}5~!XM3#z6#?FR|ALkGOg)F#ztbeP`I=7Cv3>S)g~gQ+Ck;~lYNRRrnXy(-RVvz z1iYrA!zc#oOi`F8#rS6M%o1vqdSe~gz^T(xOh|jO_o7vi+%6LS@zHmZGf7Et8ZG;q zjlw}H9%xLX<5J@u#LZ!7K z{4=cYq+LuJB$ez1LVFC0r!3Q`!x9pE{HDX!WKSzdAnzB#A@3cHw@qW3RZ)Fam?Cx> zpcwDpzR9NmHyB^h_poTzKC`n6Gb?-&seg*EztO0Of2uN;xgUSaFLJm2xI2C9!(@za zAL_(oxf>Q6A9N5rUU%y_(QvCrQewGvrYNRPyzg^r&n-5=&~#d711t30DPl0aS}>O# zLBD!6htwL`vaH?H9-ktBGn)LtxBt>p++jh&(50=6@*czp%Xk!=wio<$T6Cg%HHddS zuF@^6V#dsLM;AE!B|&89iT*k`U-pTACEcBr*Dp2fWVp|SesMQVc^hAw!@Hk8mvA$K zwx~@Lv!_j!0>8s}e=nm!eCwSsH;)d&{Jpi-`5=G`xo0oe0!4?wi)e%BK9PXMhnx<< zGpjH|h@36W;+0)Zb>_C|(idb9ru$|%A-<0?hzXQn(D1YnWO#k4@ zZ0NnVQ$q}UPqnGz)ted%9o2S`0&QWd4;! zTI|+DT~1P&97h?Cjf^(N3rfmzC(O&GGm|B*5;Ujf6hKPSNsA5VT0B>`;5kQf=+|Fu zn9owx{Q~k?3O+l)A&B?8rXbcRh#z9`+EMRjqG5btEmDF$^odz7##J2=c|Ga|4a zAzeD4r02ksSuMwCkXH8(8i}yZp9axU7Pk||AfLqgu!7pH&G&!<2RS)a_=X-`!~=F# zj7)ZBd0xkZ{&0p(otZ=E;+3sfwlk$~V}^}<26IJok&<`Mx8}g3i^4~&iSP_${)y;W z+$vi7Se-?+WE`Pb0n*H36W4OP=*}jyf-?=TExCI7=h>_S9JlsHR`jCVGj`i2m6j}~f)9R@a&U*>FEpxO=N*qyMeUna$JpE>Yto+Z$qAyg)IAz9kv zv8kdD8T={IC4G$QaSQ+@3>~SR9ujc$gk{PI$#OBAA0*kHqD&XyYt<>P1`@ln<01gY z3Y%1yPGlxd!2ru0Cf%a@>yFDYe17aAV#L9TEUOvmvnM3`4je+zxCTJ6g;N14uLkR%%{O633;w>1;?IzV@WbKFYwgAk+~$`y<}*$o3p z~7&Rzmb#s`BvKg@q4w4Yn)Q7>RPMcQ9Zb?`(4=P;)kDq#YR5a%qYKh zEPLjn87^YVsS}<9YNi=^X1+FT_U^qqwKwIA}bimDnopQ*^LV0`T3$rk9V$1 z6(Xl^AE!4+D&5>Y?{adg!pT=G@K_OkM-c8F<6)ld>JY6}9kZ5 z=9mI;iaNQVxD>nBm5HAqMSg3918(L?IU9XOw`@i+iWO*wIsn6oJ}YnXTRl5dQaB@R z=X>vg!nws^x}#JZh|W#b*sH!Qw`BI@Q{dtC>A!RADb$=Mb?`oDWy~ zn@eJuZ^A8?#`=Jz;J-f+5L}QjF`l=QQ@Ie>C4P}}3d=y-OZ;L5Q`LMs-XNeoEE1#7 zw4yVb!}(Ys^0MabbZGEOat!-x;>_?1Pt?IC3q|Kkr8fKOQ|b2Fa+dPtoxLD8LlS*( zF@cSUgI($S26DA4Ox~t94ecF)Kv5sGVXPp8=ezbw&av{?h~LWxe#)Nax{f-2)eJX! zp$0o3+YE(AZUJN`#9T!66vx0iId@Wz|L>GQY@VT87&nlGbHsM!xL)O;e4bE z8>Y9a^{(M^8=*AA&Kk(sys7DZQuDj+_1|w)(5^p-!j4?BHp6GDO^#v4dFo*>E+PVa zMGU*H7e#(pBvK4&$Rl%w^PiTt5=iVAkF|)P5{767Gi24`l6lJLL00JoX7|UI(ad*$ zOZBJQk#_p-V`x!)_NJdFLytA)mhM{Ct~SQ!;)iSyr^a6S@KNrK=cqNk$E)$x4f^i< z9Pd8fK&j|%!}|PCH392oy7y;9GBVr!KKAm(?{5jFr|^^t#df6*lvvSr9W+bF-9M3M z{7UlEMDY^x{#2;Su66?jvEz;VY&7*xwM|Y4ez9w3FRSo8zQs`hTjWtIk?N?PWtl5w zdzIjKMLl7C?a|PJLjULD1;ufvPZqROjd!Jwa&DnQKTgA0Y!vR&TW>uUXVb!h6c#uP zCbU+r`jZ-PnCVIkJ<_}0^h?0w2$4&qwMB>LT7=w3lJz4Ixo$+Mj0%-`c$PTkm)?Ee zFdgH!T^Y6{5kI_haMPNXo>4zo*)5h+mS%d4av*lxK4uug@x-#G^8S#}Q%8Z3+Gy|) zdpSg3P7jO4*xEbs13_%VW8FFHCR}@TRCJ80*oIQ&(Qm6gkhq>qUjW25(!`jY{ns2# z3;r?k_B3`*h6A|c>DUjuW#9CFg{3Bh;+>j5Zn*{XkqZmaa1=>!D9-~yfggtvJZ;Te znK^EJ(`rQC^5w%s=y*XDzeQS?V|6BRteX3ez>zB?>FB6IW?nUXpE()+j1r6_-1r49 zsVRY*igC>?B<#cI-JfAIT~{Ay!NTmLT6|%+DZMDfLR%?9bjG$1(KfjioET zJ)q)I8zXg|az?2MmE2X-$_)SZl_F_O9!6|UoLu%-l)tyr8hR#wx;cplP{=p z=TBs!fUQ}8I0q$(ZCJcc!GC9is(W@~u(f4A19#gw+e<_Ge9(Ux-3CdUu)U?6vf)u; zqJokGyCL` z!$jIPew7%zDKYzy&2LJ*< zs9-k@^p;c|flVt_{M-s6?8i{~%{Q*+L2TU`Bv!d1ZfL%30n+cZ4D92OGEPn=Deat5 zW|6wJIJ1)zy|iK6k0a};LH+xqVn$LLj?dcth>-F$k_3B6x%b7(N`mk~Fe!+763^6? zMY@V`x)%)+{{$*ODRhy`F)Q-Ug}DeCIFT4vwX-j(k?hBzI}%T|v-8TpOEa-&>>g8!000lU*B_V&Pg-rr4Jb424|5KL zH|O!M)Z_sg3T2PBUsE%ZaIHaF^epWtmb{B#G0uvO-}aN9g_*z@jI3~9%~3$i`Xw*R zwYgxcVBug@7zo7Qj19%1yJAh`7S(<_i$#PDQ^2WxS>k@>`&iyxc-|#*o?Jx7YdR)| zz!HXccnboe`rG!BSe^;bEY$JJUSYPjKFQizts1D%lbOITTV^q$RmPoBD{j_(G$_9s zCpbxir!f5W4;)J^s_$+r@b+^T?3HOVHbtn9_t0JQ{cB16tHoLW$1JRZ?Ug{f--b0- zY%$ZPa{VYuVx7#5RWJ&*O4m+Gxaq zNiUIb5W`@&`mENHFfBmck&q>v(LR{?iFNgLpbt58fA#`18jAKY-)pbi^tfppn(gF( z02!YiJ~DH2T5n#GIg>QcdQjZWbNnTHdfxMG>@J?7qejo3u6jjI?`uO&d(v4(tXwCJ zuy-QHk~#jCMMdD7IJPn0>5}c**R^F=|^Pj zb}LgQSVt`W+C|+QATEZ0q*NvX(N$+-Cgd39zscmlufb(|zx6W}E@6Q#9L>PmT;iz4b( zgqD0?Dngh;RKD?n1fU{CuhPk`Dp=4!dQOllM$g))dVYud8xz}{b}pk|`Os(oZqH2W zDm!`WwKSfO!=6!*!vU)j8ok#a#=o-d5PB3(K|N6Z=`0EL5OvPVD+{7$i=kF#qiicP zyh*9qH2PM;{$_B-$iuO3!@B?{>B++i8-qoNvF}*74nsi`P8v;5R{4&z*y-?KZ#F6x7is2b1QFG>|{aL3r&uSc^ zkI&+O0pIcXJs5Vvf=T@KPB@~i2jrsQ+TuSL!_U)0n+};=!}Y@Za$|Cy{-I&jnMu9k@Ex)b6>tJ161^U0>x>K@RMfVegMLUBs_ z{i!wodmGBWt5J)egN&&NomRWJKK{o!7s@-}769>%M>gy#!yaDusk|}bE&}e|h^2Y? z1>yW9){MJmuD7b3_`o9|AdwzE~+KRcls?q$}=w>J5HSA43kJU zAlC8&eKn&daYHy3H-~h{%W%V|HzNCqvXaW-&8nDb;7OjlaJk1~^JH|YM*AVZ;26$v zwI;nJ;G+e(GXcTx$-Q8GM3b-qeYE#RDZhTtg@3B%NSI88`5L82I8{+S5yZq8&!cn8 zA*$ky?6N7vUVxUf)qDP4$U$UG+Ps#iO;|+j%Qk~#)a?s#K z6hnTXOu)RFlyzIiw?RYr&R=q{NlP-u#SZ@;%9fd$;ZUOV@i+LNeDNXl$TB-<@8?*_ zh9fHqJo&rv2h*1@K`G`SYt|ja|BXChY&dliqMCz>WzHx!mGu!VLNbBD_ z1rrb<4_5Rk#?}k`CCSfL*w@!1d^D*>d|FVhoY&+S*j_1KnzKGO==emVgYt(YhT0!X z^IL3OUwvcinABxk)P%e7(N})pg8=!T32__3phvia?&C!--x+h+bzcpuYedYtGGKW< zK`c^5y~$4OshwQ%sG|;LK&F70{114O#2g|J_q41;O=a_KViYvT8M5|QsfG2~;wbWG zQ_4s6B#HrYNnP9pCb7CZ^#;eAwMvIH(+d;eTeQt{s`HU7V>Dwb$|3QX>UW=!28Px< zK4pii8a@rexeNtVD7ImrY}9DR;kg;0P{L}NN%BLzHW1T(4D9NB26Ifu-;r ze~wGPiW1#=$UO}&i9RD+*^lx9?3aL&)Y5!kt6S8>pI5`z@A8b{OHWuWf#6CK|F0i- z6c{w)J}uxtl3r#{&IhhJU6Cie?PIWnsS~VSE5W4eq}u-_pvDc}M{gLT+Hfp6bo0V` zcnbKBtigIcV_>0H!LnJe|Ft5w+GbCNR37n)IUBdbXlY`nmINe_>$!kZ2=CMKK1%)+ z-S@48lJWef>8kMr!$QWxZ503dHv_Si^5VKb^@8l?&A0n03%hb$VjIpJ6T6T zZ83aL{P9Auv{^J0Z7fp1SE6;@Y>V|TV}7rNfuFLt5F^|b&_L$u-ACibgoL3+sMD~% zdCH~m%7Ccqedrl)Jr~K!$M!x~eBKNi&RB9(Yf(0&?x{P8ULl0p&5nb)_O_H`K@~ui za`}MWp4)mwmtIo$T-cT*DTV%-1DKn2K`%8F4ZT{Fl-wDzY|qrl@OM}`Mgo}9VnvHd z%&y0ijhpJ%0Tn;%#GQ=aI#H91b!3UZyMb$0N1X4AgTf~W*3Q9m4>~jlv<>%9>jpE8 z>#=A2v#Im8YA|CK;^it=+PdqR20z^=yRs3bTZmus84HR^(9A9Cl^GA?FfTKRu1=ub z-qP|Db^{cq7VVlKwSPk`HIC=f2{_Vx5=!ihN)e4^mw0N6zZD1C?4??W2z!7Oqu1Ud zo)DJ%Ll%bb*M;(5HUg=99w9a8~={$n*=jx*g8;8?7FW^V%p5=1C ze?9$t55xN!6~`d%%%g_wP4akhiT=sx7*xz@d@b~O@~lyG)1h`f;=#N5s3!58rew1R zG&QtOk5ZA=6VF&gW>|6sTQMh4u~XM^GeHDe+c7nN#I5d9?aafd=i(tuHwY{+i9KLc z#H>*eQ`RUoZH{jNQCj;$)|=lioe@lY#cRv4KXv|9I$5jxdM}s~?8?;#<6@75fe)d5 zeJP({%(Rw5cBgROF8sYSh;V^>l;?@e>XB##FN{1dkB{EpF%wBstf=F+blz|4+jhG# zLry?8dNW44GDotAA)yk&-#&RrVDv7ZZ?1JlyBgz*R@iCQDiR}vr*tw(W(<)BP>hfl z_7t4h-IzXnBl4g%?e@we4?7DEW+|kh%N5lNOp;)<;SsNYF5oRArb;<;tlh+fxYHY71UamA|zaIJkw08(~}ctS~35~dxDe>9mrV+PkE6Y z`qs@n<9X*!mNuwRDOOBZ1KUXB8+nZ8*)4}N(+cs+?Cn~m>4@Y2FsjS%Nn)Vza#LQf z1{$wfn!0j^^H)lz;tH4AJYlB6zFf>GWNNOpgqTB{(e;iVh#h8fz4+9Nu(-W(-S_Q_e^BTcXu?BpUgVO>S`<$EXb7$J|6yhj9>#PwLSu2t# zy>HjTkAEINyCLPuRai_?w6=&2Ds(UtDi&IAJuD`0fey_~94(wX(b?Hs!cMQFm>A`h z>5tn(TkDaz*Q!iEe3u8SxF$GTKR02%JR>`Dl4r=2lErDl?t>C~4V`G{`9U!1pUa22 z*hwcSj0*>01W!OjAKxp_61);qaog`{@~9AXsH)qaV4 zxyf0vO?hS9>rW$2WHOT763shZf)QKEfkf=hj56D9$<-E+$avzkowl<6qN|Ae!D^lC zyZ#>kF%ADp899Dspf{&RZIa+%Fuvu713GjF8-9-HHcf|O%J{H~8^%;soN#vMAMz|E z<$aqDIB`G2yR@dI zPX$O=v$-N)!2Hj?Y0|}-#~jL2-S%d~Bw`lme`kOc)69LXGGOp_$2+on)bz2w=?I4o z*3azLJEP;9@A#F|Qih&0c?qs6u_okFtm4G74Mp<`e+cbPJc3W#i_xff3G(8Kk5uZnRClUVU~pJaBwueeHi5mj_UckW zs=C12NZ<~%0@oEcEY)PH8g!gMiLD~@OoeSkFd@@n1flGytyZL(5HYMkC%Y`q^*i+< z6PW!QQ=P^0%U+LL;-=wW>9Gc&(Ph~lXPH9aEb4gxJ#a!~n)owk7) zIk5(qqyP&(yeH)=PsfWS-uix^$FC71ni-%u*$Gh6aJo3P+9CJT+RK#1wO422N^aB* z)!$sco>6O(LBBp8*?c1{ZReD|mWzLXBWbOJnrS21r3B_oYj6>GhO;=i3+<(QQIzY+ zUU?z)nTZ9B=5bViwwo1>PO6Q(M6v#~TKeY|>YlyH(6~lO!D=j2IGB3vxxH1bP2F&} zrg``>C+cR|(wb_Tm3_`}H5C=W@-9ndt?2^cXPTqbk+cdL;u@@rEBKH?i*7Fq*p5VD z>U6owKlr_|W1eHAcS0R%I`FC%B>si^(LkPYPy|^UN?^$k)_o1%?EwrzT&e`)iu0sPeUXi&up0TzW|FJLq zWuA9?-_&1fgE~*3tUB^XVblTjnu`{?O~{fj_HT=g`s{6kp$6&WNla4=YI599HH?Kg zItjO9X2R^_Z{}Vo4mD6O@N9|%-?EEaUB{ep=eBn-bNputK$W2JBrtRQ6> zVErg@^G59FLa++m{+ZFXHu7zu4MC6%Rg}T@#&5}G?>PeT4VvwMvetXPK_o_%#qCip z*)PJO&q$9!fhN-pc1szjG+*FfYKoxt=J^rn3KcWN@a`!Lg-<@A^xiO0;tso+D%KM1^yB@rnRz5Vx2o4uvV%irDS^Lt;;`*4hQwITUZ(9*CNG|A`7f9`%BF#rh3l@v z{b$t2P@?TtrIfdPPZc@@G08)Q+rRt1Cq@grv=;*JKZYomv54&T@0pNR#NO9Y&wM)Q zn7LAa2%8&uAg0a0?OT_%!?fcwp(MNWC<%6jXc=cdRfu{|1zJ62OYhM(C9|Rw_MOc; zm2khw@5rrl&WT0(47llUzBdUqsvphS45&3=7fvn|-Ii`(w@f@|yD&PdMMWx4&N*T* zO-T{_Pb1iw1->hc`;g{KYweY%WQ1D!F5Cdde}yYm@bKNz35zenn>YESz?MT+K|;qM zfI8mg0HEcqB^SeoUb9ZVu(xn#`Da#{G@EPB^Pq2zYi)-%LWV-2%nNXmjlzPcTZLVZ zl(LxshyTxjUG@XbFSQh7@5&WaJ*h+_W9f+H1MViVnlu0me5}Wt&aSW!fOAT_ecM89 z?i{_BPU?BKQ#=^8_ZotGl>24n&0Z@#G5KR46H&M9ZQryXTSA%+_^a}G7wj3LeM$Q~ z?>-8^cJ{%@PnPua3Z`>wha*Z$5jBNGWn&27*xRL`FH;ds;SudPNbGO|dUu%>5SNCK z%TYhiYwI43zz1SH4b|f@EksYkwg%-h;Oe~I@bm$AnqUWhFqNcK0J$(G_AB=vd^$jy z^FiufGPW$wV{9$E8=gno0Iz*Q!ygm?p9*gp1cKP4EGMlAumIV64eM;Nag`|LO@|n& zpM?Kd#mSBDE+^DAHSdMzV4~t&ONoAbqZInT>p?sG7u$Tsn}_QX-Lk53{KT(kolzl+ zf9&MMcTp_M;Xe)J?=eY0^7w4QU-H;1rczdpA3wMa^1fH-jpO1KFua4LPr+LdNa0?C z^Hkt=^#^D^Ptza1BJSug?G|95e+D-G(bF^jh!BtKgYHW6UVOMC57C4-rNa6r6QuR2 z-(eEyA*t)a{rG_5;&C?Tj{?!jk6Rc)Vpy+HNpblku(r{y*iU}OIH2Rm8-L}z(eQRv0aG}f%=IzaD%|2)4l zQ+KfY^)9MzVYhX0(E=Wm + + + + + + + + + + + + + + + + + + + + + +

    + +

    + Sandbox.create() +

    +     +
    + +     + + + + +
    + +

    + pause() +

    +     +
    +     +     +     + + + +
    + +

    + kill() +

    +     +
    +     +     +     + + + +
    + +

    + connect() +

    +     +
    +     +     +     + + + +
    + +

    + kill() +

    +     +
    +     +     +     + + + + + + + + + + + + +
    + Running +
    +     + +
    + • Active execution
    • Consumes resources     +
    +     +     +     + + + + + + + +
    + Paused +
    +     + +
    + • Preserves memory and files
    • Cannot execute code     +
    +     +     +     + + + + + + + +
    + Killed +
    +     + +
    + • Resources released
    • Cannot be resumed     +
    +     +     +     +     + + + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/hello-world-chart.png b/apps/web/src/app/(docs)/mintlify-docs/images/hello-world-chart.png new file mode 100644 index 0000000000000000000000000000000000000000..fff996100c09ed620a9bfc08f6c01a48d9fdf1d2 GIT binary patch literal 21910 zcmbun1zeTs+BLqFQAb1_129lV1*K7xl(GSp?i3KEm6k>w3&hwGBB^wXfHbHG2uMgu zqk=R@OMmNTX3jb9dE!qbmDpDvk z3>3m9AW}b0PtPXB-WHcb1exNG*g{k8nUY7cjd z)rFtgI53c?l~Hz)&t$T{zOie*@XkgxDX9B$Gx$*vtbvt^kU6;m4v%@I7fEyQ3uo6i9Qk6*|gLXD=w_T9m*cI`F@UD zCtEo=cg*wj!`rcxSx4d$xc7sFlWrhNNnc1@NZ2#q=G&+|;c;@NOk&+haq9r;poOcHL|d-m+n zd~M#ufA`geq6O`1j*ccXW8E`l85S*39d2{yLqbAWx9T_92U1VbXlwx>BTG8A*A)T`v z3xZ{#UgctAl1_hnUQTXaUg8`>!+{QS0rF~EIy&Y0IFKqvp%mj_r`V^!i+@teB!f~{eAA;bJ_ zz5RIXeW&lsOG^5Z)H)QLMAbVf6KszMvF+M?gy zTr-fAGh8z>-ji-W)a)`zS6E#uCy_WiIZ)oxqJ_m;=g{HmpRB8IXvt%z#laO4pEs?> zck#n-!6J4tfdUq<{JOt?H^n~6o*T|t*V;4F6RL)%RmripP>EGMHPn*9JEk678!cxx z_&KG)xjoH9sp1*`Sq862skxT;m>y2!`$Y|jTJ_IQtZ{U7jFo<}-)XX5Em?@CUnaDw zuQuB3-5+bI5vRR(bkE(_>2u!rChO-D8V|mncIT1$uF@xyqb1B{T^}B=YM2?$86kTj z7Bllq*d|I;Ow6wH%?j74rpwfbf#d?+!SC29J8y36{~mb7kHv1Nx!&o%QnYNW z!$|uM(Q7ZsB3|{&FWQHaE{8at-v31Up~PY)A0OWlhhgngCr=tzg^0x|M#?-+PG(D4 z2-e@$-g0> z4GY@xT&uQc{cj1ZZ z$sCHi&cstM}PkKJ5tf?Mcs$++^oN5o+`=v`r<-9)c~ z*hKXS)9SG6_QS2QfBf;wF6@8o$~@EDOQ{+ML}2=Qn2t^*Jbq7%*>4R?D%2(^bs-2fy0!}9a_29 zQudVo?2k{TP5d@6VAgu=n|DKFZPfY0i;Hp%UcC9nQhc&OLJGZy@@M-wPf$~?jed1$ z!40mLE`E1w-MUtW-McMa^Nh+FPEZw+b;b5^a+Yf@RvsPMM!oMi{#~Pdhk&^;-A;kQ zxRP8&^TONf50f9b2K)G2l;R67h^a%gvq*5?bjkGWDWXW71c_ih2BrMZqJI_cta z-h!YJZFfN|lM~d@2CXX^<<>Sf-Y;Js3`dj^Xl#F}egQBAbHqs_j>qWHXE+eOzr z<4=1FD=I2JeE9Iv520-vE_u2m-*vrLkpXw8sN<_WrQcoi=Etv=MpiXopC%ejSDv6@tZLWw6Z43 z28(#!y<0ujU2ZqrDvYOT!xY_WKyu9^t9_^`^^CBvaKl)9V(AzbKwsdMeD<`X3a3vO zs~BQw#qHg@cg&Y@!jXG;2Jw+#27Zg?BOR}Altp}X|9cF8*UExOzQ-`%T0Ho8asKR& zsiBs1>_XQcZ`U+uT7|17X~(+He`B8g`R!qMf4@`x_~*ksFJfrt-Wm%8dTmvbW*ZbO zHloQ(_C2dq-fmlaewF1?x4&Lprj=pN1INheth6?)vK_+K5j8b6bvX_r$1j)6PSnbg zlxjE9uCuf_U7(U-sgsqHV>bG=XqBwioCAZ`sf<=@ul=$?>YYf%?Igr30;-6XiiJk`;9>z(8zq`EzuGg{<~= z=%w&rhsNoSqvg=;2(qe!VY?ng0{S6B)&O+^;5)OPlY{spmPRKVX)yto6^uXUqbt zSX?@!S>WcHZ(=fZFA;eNd+C{kd;a+ugllY9Wn(>i=gGd>GbSb`0up|_y16m_dTtuP zL*@S4wiZP;c;4G`pdULV&9T+4QHOTp#*Bu0cke#R$;r`mn=uM3&}BTb?^C4stoz7Z zXmGH_VSY<}jDvE#>Un~03Dib<%d2)uN=o7jI46+E27Iijs92*?W!0$Tz|P8g3eiI$ z-y&Krv@*l*cDSdrxSE<8@;n)fTk69nB8K4 zi4_=mb(Ni*vc+e*wqVkw*Y6al%eEUx%KW_@X)WD#&VF*JMGZeyK7IQ3;=+h~yxYQT ze?wwmgoL|GLyW?Sb&Nd92;wT~rYhKj8W?2`)m#Kq#SF`~tvh$dPfXZW1Rqrcnn@4X zJbiu5?rJPUdV2cEoZ;-V5=--`?M?&Sfp6ocitXoyGU6{+g*bh^cfhu{dQZAViz-3w z4M{rjDTXEAkJ?*_{p`F+a1}qG1>o>m0?;vG;&X$C@gag8+aA79e{CLc{KN@*CMNC9 zDcq|GA}F8(0V+q_=C85t-{1eb#ZoC$+%?U4+S2vsmpcvYXLz$F8?@@fj?s8;J9K=@ z{&SDwzj0f(UG~uH7J`2WAa81FYR+*;R!!DT1PtkRmSg(zVTQ~rV41pLo9&a` zZa?+SHn+y9aOS897If9f49kg*{;_)FZY~E0hc>slp;NP%w!P7n(yPK0vyZs;MBc%l zP208^w_2BT7w0;Tn@92Ib&d6%dh+Cn_tD|Z!e41=`A|*V4-5O<@WZ1$Gg0N*IrfR4 zUKyPosPp%a+O~e*YxSTEJSJZOldf13mzF=z2mIk8C}g2@Vtii(`%yk_&(bTaKPyjo){PNB%_pE`49 zAZH}MTu@-GWKq$!breeHqw$`qmfXd@=+HF%!qt<#p9+Onthh>x-AVB{fh`sfd>wD~ zt#}sTd9sW%neD)VGe`}U89Zw}JiXqwfJ@k;prGJ{ZR6|bw;y=r)~#E8O_xJiV<{Zl z$z>=Mq5FsaBinF4h0UYL0JU9-a-NeN>i^4kXvphs>2DLU`FG9hEB!l1I*0KsNC7Av~`x8hQFP_Ws8)3zO0~YC+tt>LHrJX zHtb6we{~)#R;N%nc%Dd`e*Tf%Ln#wWZA!?^6}@~%K|eDmr+jkc+b5>ZiT4I?Z>)NT z`=)O(!le<165PgIKXID=~>j4 zs2&7KtRWS|!-o&^=Z24>Y}6Sj$7D#Z&GJ$HIX8#GHSpB^v$zjZr2wC>NMqO7^s{d?mbp59kPT8|uvLT}En12rsO5hm2L`Fu^XUb`6Hq#GW#*Ga&rOq}MEJmUv zbDbY8>F+2gSWUMr4A`1}$5{h|7cQ=@i4QwFFRV%4K#||C&Q;T>w>0xoJ!sc@%9>9L zv9>;SbDGbi0@LT0mW~W(e%m01;6uB9eLY5zl;IjVGW0Ba_8bHDYbbfV?@W@)2P{y@ zTb*fdTio2-tnKVnkUh^k;tRO8b*%>u9{k}sxiCME>LtpLTdTP)YjJiU-LT}ral_Gx z37_cb%T_#O$9V*OHbCro4kXDbEZn4dDMj5UC@A6O%a<#s*RETaig6^gM8outAM(iJ zNF?HcA}D;+3eS!|B^PM?@Z(D%2($@MS%*7bD}@cKt?f0BvMo!?aZ+5a(}fLyM`c<;=TL#pRSTv%8il@j;pSgC+K{qpk>;IYH^pJ zFA3;M>_|6L5nGnzFL8YBaul6tTE4XZGdYEhms004Qb)(*;ZQ2&nOv zZP_~G17tv&)6JqW(O@cyHD6z<*uigHEh*T3Ej<0BK?)n56wpM`mqR6?z=8KrV8xC@ z27lN&gOB0|MG$DSo>^QQWsuY2Ob-Ft^+`HfNM70d<9(01b`ND{3L&b~XC{WJ-X{D3 z!iAdX_l4<>WMIhxmUlE19|t$L$_Erlld?)4m%#Y=iRn|+WaY-9Q?pAAe{eP=YS!of zT!G7=-nJQb_ByxdI>usYeKOKXm92S-%L_Ui8ii!eWT1 zVRg!h9Kk|g2H7Y+QKt2@9SzYBC*H1c&zqX|uMFnQw7ix%F)d+w=MSj^a^I8HKBh;G zfI?zrVd=#^`mzx2Ni)UZ7Jtfz($Y_TaxBH!(YqJb-mi7$g@(J7Dx%3E2=Jmy`f*`B7@PjutTrOt!VPS?C6y z+dtrRCGs9VMP5IvTU&nc@IxsogT&|+or#I;vfY%jUCza#KB{edJv}`YK|7t>|77pJ zeHO3N&6^YfMntgOQ5vmlUBXx@fn}Whu zXJu#i1FpXmU&;Y?HkNJ>Aaxq06$Vd=$S3fTE1X%=pL=^B&AF8oBkP?J#H0i5} zoCV!f7o)K6vbL=Fvi9(X|LeDJO1-a1RYcYpq9iy9#(JQ6!ZCx6WR)g07-71eKHUb8 zuzow=Ny7etUn?}DU!)J93x9f|h4bY<^2fNRATvdNYTot7>$zJt&xF&wSWNm~Rr&UG z>vW12ZO^Uv-Kw)W>*|*q8+MDv;J!-By?DG?hh#>Q#R|NFvn6+vi0FBJdEPt<$p{ea z0*vE9%k9s8X+`I=-?5IB)g5))pS_+xd-=`^itkFD=XjMokG5BRIA=K3Nza6U2g!i% zU%u>NWMqWQa1KxR7*HAGpIXQ<;o?M1d)^9KJmA19%fd8r7uxi!v<2WIFiX8og z!Z!Vsp2%YVeDeQlAULbawbqWfeH%PT2~#BR_tE&+@C&7T&GI;4xETI^m>k__T+&WG zpDx>dDy%Ktv_i7zl-DXs*gHOrkEX$|q!X0{N-rKddX$M0Q~mc)|Jw)t*Wap_tfX8$ zFJwqRBwEGsEPK#qz=pESG*Fba_dglS%?;kQilR&l(g+XJd5}O*dOtJWq*>k|c4?=P zP$eV#>8sW!De_jIFeWiCwLdb}yA6n>cVx@*eD|u{u!h2s#`jpAOZ}xJDm$=1ia=76 zAWC#o7E!0yy*Rawkn2D}%`f$DR!jjPmtW*-5=AX0GrpM&piD*Iy`nN-PI_kMWRuz` zc7A>pAOV$&7bAe5XcGz`(2%tZb)kB=Er)*BuEgG6V^<((fk{%(&HuC-_%@W$kP)s!f|-MKbVcvtc3RA*-)y2o<~%g7+QKfA@UxzE?T>>sdOt%}Ru(dqKd7e!BakxSujFN9WUkLeL_~b9 z^N#?H>N1JinZw=P9jQs1XlkIjRE(LxWR;bby>i5bC~P9Q5?E=UCUaHDBH+L-E-i zZGUSF;AU=W$Tuj+oI6#WOGZ{!Rb5^E`rIG4ZZ%;nKpN0%>QPYv3lf_E3tydsk-4j4pcra+!NsTAIzO0x_q=2%Ll9Hw`6v^0ZRc?kN;fLX^yg{`epX;zl zEBU)7iSmw^?YOTE->R5!8@AeqOtEpG}tCY3QMN z)R6iu<|Q2?WAIdR&vHNtp$x29-+Fc2{ENvIV;gDsAkADDuytQsU3mZTD6!U+91SHst{cXxY7AA{q6x4P7@- z*u;?AJZQ_WS}B~q8CAJ~hQhHb`#9NkSGRF5|AwDePOM@63^mQ}jZ{EeTQJimgf06F zbuQgpb;KD?Z+t$R0?&8RQ@N?~n?|^Nyo9UBnBKbN;8lcjfB@z7JB~;ZX%b2M>^^LU z-`VvmbaVO-Y%tc5c}#iZ+tg-Y1ubcLIvvL%h$zOut!dnlpn+PF)B7iRG9McI0}MzF zq*Ni?*1j_jj3NC&^$OT=#5jy_R!GCI)VU%zapL73d}Yryp08ZFl4N^S_@zZfr<|vU z>&aS=kltd^mYx2`@n7&l`38E<6e&5mMkwdWJ1sMhi8)Qkqs~GNn0#~1#{S+<;i%$r zj+lRbNqs<%H%M+baxkz$@Z$t-KkLW!37C;6VR;KvEeK1GSX2@7qTA0 zTvBp4ee}110-Y&yM?gT`>L(>n@%WnJa46lg5|gVVaqTQMEpW7zOhRVz)s)9?C}oT}CF(DK z?7}}i%IVotVpQV&rbaq=B_t%4DfPE4{_~4-BdiQeuU-L^=!r4yz1(dfz;y>OsNs+W{sxM6G&bIA;|-7 zE9XImb+=4WNeL;o`dhP7zgGswfA}B;0bC9m&`keGYnIZ9+jImpTILK1kZKKsMHtq2 z)kO3D{ONXQ!kW`>-Fk7vXeEWi!)rK1^T;>;f$_31A+rD$>=fF^lo<0tUB|iScXrpH zu49!hm>=^pFfiyE8cM`vOuoLqXTRphyLG%|UwC?ZtCah36ZXQ<*?9nD81KtPaGqPi zA%ku0MMco4BqtV$+Q5-C}Xz3W;cBeYxG565~UsrnbwxUSW-vozIv4{=uu1 zu;ZymQ$82C7l0OFU1(xu$3iXl=WT?~VFLPlvt2@KD_OZj%yVDW_4UQwyT3+8L~PBJ zlacW}?<(zi|9)ERl@xVb7+p+JBWHiPy)$XY8Clr}uU@?}Ct#N1Svmav-9b92AJR2& zRU{hjgx|$(tV=rQ0r?883KIQipEbYy!p6;=_{J64J4w?WfdXYsZTLfR%?KgzN8J#K zU4L1#rp0a-#p6|Jw?Rm@OXhJMaqT_+UXIIv=}68NuMN9IdO;&L)I^>IX)Zt*dnz{N zTNjC+!TJbQ&j3^WxHJ^In&LNa-s}?)VB*RIt;r|+7mD_}B*t;u68F&hT}!U2Nr<8H zaf7m4WY)1zQ1tfQI}k$HZC2@cwPaOXY)Hf}G&EFON5?lL#8L_6OwyY-Z@^j5(d8N} zK-*E?zI{8<(V^254n)s=fy59c5X{$0CIALdsDSxF^!d~z#;FXBBhBH;;`RfVszSKc zj;<*tI2uJDfdaO+X%P}7XIKs#;N;;+dgJ=;-8)bu=7;SDAz^N1VAwC6jn%e}>82H? zfkQx`A!#|jZuM@vSHudKRR%@+K}Kc-V7dLS1K{f*RVjfI1Vwm&Xc8di8(2EQy(#56 zP5J;AN$)s(={_nm{>zn2WDp6LfeJYBlox|E)wD4w5x}h_s1PU~NXN82*U^fX5l`}l z{&TSUAas8MDkdskpI zv;0?o5fZ1w7oVTF`968FPrB^m$2ye7T7L&?d^%BtxwSLp zmu9Nm%`g3t-4_+;^X!@Ci?;+MurcEm;Nqf(+s5VEdIkpK;q~!9d2adXw&UsEypaUE z^1I#)szKn_hQ7eL=E*1p{Y-QUJ6}XCHjk6mgquH)? zg$I3neIvn|f_iwRevBlp7@8r4 zOw^p^H33Lw-OYk~^>~%|p|-*eDm%7@b$-NgDl{tJM~}j$JKPIS-Xvi}UVN+Yawx|> z((Ii|(#at_JnLqHMm@$NKioS72xJQWqjw4x0ya+0coqXP4DywD-$A+)JUqA51Ov`- ze5Y>1PbpS{l;!W+MSv>evt?`K~|IqcR3 zhXAN*?$b~_Hea@~QR|l&zG}aXBG10n@%}Q9-Fll z&*^`zPVoL5a9)uRjqpOheS0iiBxkU2A~!KFzx@re5o)rBVpC6Hk_iVaI8GjMw`12P zm^Aw!uGbTjLCxJQc)8^E@70|{h#l-;z7c95wI>icl&G1+T7r<7L-pLW{7SWi_j`GH z<;W*PQzhWe6;eG>$Wa>-=NdR@dAL0|`qWVvcr{h%m@z+1NZ)wQuc@N#Ps}&{M?29i zh_qLDkfhZ9tey}hz=?zwe2MD`b=N(1>=^3~HVS3xRc6+}c>B%ZU8_Mf07rMYFXa&( zef_qBlE_7?8b-&*4K+0>ndja;%d6b5g5sfQ=%5w@E`X4>GgMD6MqX2toKzM;K|#>o z{^$OnP_{lPHCGM4QlNPclTyLbqI3S($B*YG0l?Ic{ja$R=tl9# z8`!OJ#EAm{K^Vj$&-D~}x2*2&-nS>sfcU!khmbFaO~R`{$>^q3*sj_V(|Xgq4qp2Krl#54N!8;5^dV-8VM32 zqBD%Y&mTSdt<7m5kz}E^QL>yfMc__8t-!GXV@6HGwmEg`RFmy37#n6m8r0=F+JNZ) zltlSgeTl`Z=mp4i@7-dWPxhZLQT+-oRLi`?x zJERjA8W6w^`7bAF4TZLFo0nPD!aLy#rsh-BBX&(aW#eP^)+g!DKtsTEz2U!5HS!f( zaB6bWcjB_wDPk>%l%XFG05-Mjt2u>rpT=4J7dnHdwt){^9x*$xvPQmfg)d?&GxHTC z25bN%(c@JqFsGqXhyw|;0J9-gI=+FNYm8{apUYb#jVDKWl4zvxw zSwo$-V7q!}=g?Wqy_btMss|9k9MI8;CzK$NRl{3AyF|lD}5*9ZD)_?%*xXoP1|R9F8@UuBe{ZeFYavPj%3K1ZN+?&+j3C2Rsk%2NRg&FfWX zkGr_!68;%bGzP}aXGa~9UZtke@7&2Loec+%GK6thFJ!0?2*RNiR0JG81C&?qNzXX} zL~r)##VKk8tiodB9}g2dDv`foUNeQjE8;W}1C3w#1uB>_0niBI-Vf~lim*TIP44~A z?8^??n!hw9rKoeCKy9M}I}A;U*p8_zFv={zvgHJ`nJqv$QGJlR>Y_v4;!r@pWpDfy zBd2V8O0(nzh;=n4wNZyviDf$NFCVP(sCgs8&=`Wik#|!HrzU4n*E$wOxUf`S5)!#b}aqoantC=hs7REkWik=EnQUUK3yCt#SWx;|y**7q(P$P)nm$;6R-jl(a`d@p5ka?%5UMFy5HhNMx$ZJ?h zvgi_UkZB!T(fjwkzG}LU2bOq`;4X=>VT>DZ&hcLrhTFQ?)TUE<=%LV2I!eq|?ZLJ$ zu=wo|v<%{peMBY$b>{$n!n)(n%J}W@`xnre8&c@qr_n=vfq0p;gBq2*e?tmMWJ5b2VAm0hdG6RLF437v#hthoyc$ zt|1}vt&d@m=I?UUd?bur;x6h)z5?Aa8rujVZ{fXOz|Fh`^Dl^yiM{}VZ#=+?5fY7L z>r>>jK8v*t;;xBM1HJtNOzQ+25h)N`${6rB^0&Qsp~tJrVFoWBpRKNAr3c19!g_gm zX=`f}ZirZ$$g^XL&hC??PzEnq*)>kN6(;yzzxgK}x9`G_QWn$>hK9rKVV zVe{0(+V*9Ezivqh8WpBVWo#2x>Ny5A!N`+E>Y+3g8M()czLS%a>5gJoJ0$}f&k4d# zc4NqYhwNwv`i6#>jkvunD5-&Tsmz_W;fIpO%pGC3LfE1O`0%2(aQJ+v?1ZNS> z9eb@036H=t)bsTKV;?~fgt|@z5b0ev&nZ?dS(kRhh6a@P7)sF`8g=-T@wmh<92pfw z00u}Qm?TeMpL9S60oIA}`@5T(^PDqYgohKM2~7d2HKE)bv9YmE*t;-m$05lZqgWvc zuPucvJGLF9Z!GU9cAG4)e=R~an{+m$CVtyqdGw(a4gdcGWhI~jBSF>nfz40>7*E=v z^e0U7{R^5U!*mv-nCLbwrM=)bJE)u>?hMtFK!W98T(LV zYXl21s)HGlk&=4pmz9~xws-Gw=>MyRpHQhUe*U}`_zDCfaxT472yiswD=PZJFHa%l zAc>sMahgb7)`M~ueeE0^GPY}di9zZwGZ*ODNw@pA-!53J&(hY^)Vw}f3xO-a{mZ*m zVv9e&!C)ozTtgLLs@i)V!SICAL@EEHaw*LYWLIz-wxVaM#^DeZ3lks%n`tJdlKh=}a zT%qtV($D$9>`!7BBq1Y7XU@~=nv)Yze!gQ%E@2;7IY4YBu(>QIADXp(S(^y(4-{YC1}2#w%D z<0)GFl{hB~mKLs%5*DIt4M9Aha!L(Sd@i|=$1J-JaRAgEsdW>Q_wC&aFlLL6FvYbb z5lPM{bS24SrTGw3XaFqU2sJXIY?Mqt&)PdXDU{C~)&|(%=)&ZIUDK@T);dOF->SXD zz0SD-#DCb4?L0}%JMF#xMAyP8@Eoh>zk(Sk`sB?OlrR>Zi63=iqc(r0Xpj;zP78#F zqR`)I1E+w0yy+&2KD{6Iu?*Aa)AwjvKA_qnCQteu|0`kbFWF7~G2;gsN?7h8ZS6_J zoWNy{@DAt+d3|yVJLS0kBsr@8vu^>G7(Jor?G6q#_j8Vx{^P?9$!$G5Q@QH$9SXb~ zkmT^^A5E~N&*V8vLes$DZ;1Xr#u$r#afOCMTZDVz9M5d`?G68;Kk_&^^+_Dob6Bnh zNLu!wjTCw!^q0oqyKd;+KRzVpB~e7TqHIkk{Y7pK+m~YxO@J5bBI#d1;+l8Glj}vPN_s`LYit?U3M3 zl+eiY8M{)hCT{KN*r_Q@(UN7()nQ=SzrU=pv2pg-4IAw3NfjlT^)+po9z&0XjGSBs zJ2t1~ky&P0e47%ZZuVuo+_o$)daHgB1|#|bb&3&9>hTq9 z<=7U!$Fhh;2m@Ml3^o8nBhu^+QC_SkxA;L{a*E+B`Dbe33J=GMo46t>*?fPXIElQ+Bx_J;HpK8*VdU(8ClUtabV zq%Gt9|C=uXV*vM3syIKO(uJaC#+VPwfmjuVONd5pMUy_Zpd>mC@#h~d_rKg{Hpliw zwc7SmH{`2rwYV9ReN}k#y0Dddq;b{CaI*D!zGYmq9#-dUGd ze5!65rA8QS(XBqUQEs_PW?cRiagsfrjhz(sxIrK78?>S$lZo6iOnV9E(v}TeXt7k) z)O^#xc>|MAojlYePLCXJwIL#uBR{S7cr#@C<&j6kB7)>YAU{w2&=KcK{#{<4K z8~!eU{L_05?I)FV#DLoWIVJpiRVc4C{1^oP1C8*T)I_*U8X6e*z)lTOPOCiIw(kX) z10pWn)@Ng5lL7}{`*ReILZ~yezy4YcUHQnhAD!{VP-Fh-*opolX{+z{d#gH`kdRD( z-Tt-Iy~{0%byaOZ-<_}XN@1_$k(fjz# zXKPaftN$oL_o63)>uP9PTH4Bi=*UQo3_T9cgvxFpYf`_u2BS*otD>vWh)SNTTy&jn zlc#+wBxlu5L-~2M{MLB(1g~RdmU*`Zm#p_1$s)y|4$tl(!S+ZqE|~)dq93NPt%H)y zk2Y|ZZq)3uccXsl+S=oOR*O0Gm448zq@$5sWt-^c?0c)@8d0N?lSk+W{s)hlT7r9D zL0?}V>BT)CTwPraSKFgU7i#m$3{rX#7)kE}jPZl{JX>{;1&Hq6^*@iVU0)~~*P{R(3p7uPxD7IM%; zx;fZZxL;6JgBbx43%d06{>{jVvtPY%eWW06`Da6sKIjL9^jU#uG)=z=QkG0jS z^St4#=4LfgCOE7&QPqLR6y~VZcs$)ie@d%G~>rCqyqqG)M>Uan(&+hwy6+K8oEd< zl`OS(GT5|bOZb)pvc|YR{76d1#xVkxt;V}tTz~%1&&r%nm%N5DE*%F+5Z(kum@3?Z z=(b(>sVUM492!77f7pdco&P#iFC>Nybm&42^%ZV6}D4BeJ{owDupUvxhGGR3tm}si)kIxS0e`}t)J>G{vk&nM-*i2Yy;PDatn(967f z44!^PtPU8P_}4QD9qf4F$F@r?$KBt3ghvd;i$!9gLzQrn{Rq)DQ8W-@MkP*J0kt^s zp9G4yOb2~4okla84moTEcZj1fNHb%o+iYpnhUrRStn_*uoS~Aes{^|X(PWUE&HJ}@ zw=<#GA@25!j0}jF{KPVfW>!sInSf&k*EjnkmcZIW2=7}B_dGpo;6P7&NILT_&EZ)m z+Z;L&AZsvm|b3`ok*U*trC|a683qZ%4(cIL3(k?F&}9GWivQ!p_Y^|#8U$f z1|#tly)jo4d7dlgG%w7}ISeC6Ibrc&w;TbfWVS2cxzZ}#nGq`ybK8&O7HUYx6uQNT zx`^T_wc$%n50hH91LB;Bh$ivv5DQydjzc__E~&jh1E%lBK;U7bz>4+3jMfOd1}dUx ztt)x;NzR4>f%Paa31I2@rbnzDTCMKjFoF5P*=HlVP4d-wIq>b=4>)|e*#|UL((iL{*sHtkZ zjlc_VS&A=zVM@y^0F8)5q@IVV>JZ&cXEnczIOc$QADqwj+X`vUsc7FLU4K$%&!#pw zcKfQ)LG9Xi;6P8auH<$}uT?t-2wX5RULo#%mSG(Y{S8|_TVT~gNM>o(o6>@Im!2E;i{zDXiqi~ z;phSjB3=wS&2;-u643$UZ~FP=bFyKv71-I>K73D(Wz%YHYfDFe5@A${Y6A-}%;1D& z-ku<*9d&;PzYIs)2v~UMzSHUrdXTNucruIj-z*MPv3pi z)zfnTdNxcRHBs|0#AQ^{!jT;V*nk6AnxkZ$oJ6LR=w@)D0O=zm$2SOcV@#vafl3bW zar$zL(Ux>yqssL3@>0TvBCW8}c*!g512c%1B;=z-D~W^!EML>s%oH-PzcDgKBi5QB zK%zY~KRuUidjG+L2RpbF{B_le=WygzG_KoW3+94!6o`|cuvDEht@s!oO^)p$U!wE&XC4; zr11}zoE3)8qi~xVZZjJ{6M&H@Eh#zB!TgnjCj0pF_gK0O&9lEtui3b}4tg%y^SQ}J zLI375lZU|$bzjs#ZdFE<2C)acRN!&u)F~6Z~}+uWZPQRsHp5l=AsgR z4~g&SR+^dW$>|YQ%W=S>e0EU(Mx1i&3lQFfes_W(GYLbb)YqJzb9e=O73BDxI<&kG zwdJS*n<>C;XV)nFbcL7vu2x~`Kd;ZPKckr392uI>=)$!yL$iePXEJ^A}E z0YApZ_~44P#2E)AFV(pk41cuQJU|+QEonQ}vmmypH)$-#!<7oIXGcDx&Avh<9pqXA zB$uO4y|*nVLjl%=!m6sOZICdbJ2-eJN0}eozB(Kf7fPYq|JHl`SM~b8KKRXJ^Cnn} zLD%9C8d&>4HKyTsgw0;hVgJT)8jkmNCI614@CjOqRvcXUV|T$&aioA2;1m%N(VGDp zKw`HADY}<=08M%|ND%7QZ>2R~UA#xs$OqX+KYixkhSswMk$W zPI#@z8CS47g`?Zs6fL-jjGQm?(Qt#Ef&rPt*;vN#Es*0XXcOk%Z;>;Gk*^u1OVaa9 zx{S!t8VGcxJskeJUSKVfkBT2M>vbN2F=r2Mj&uzzll?fpY5;!4T41C|wAkvBG>OB7 zOcQP3GRcE0jx?$Otj8ch#lfjZ8lZ3~fz`xju~CjCEX zUt*Q65*@#9nbqy*(!(s_mODE}vkkl}3{AF-OWn-Ve;@c~GEa@(yL(Cze)Y--n= z0_)6iNDkwVWxETE z4o5-+a0ph+XBJJkfJoYHN=8fp5l{vr5i|x*rUMk^i^MWrN;)NwGSb;ewlmiaCC4vf zVeW>I;4&v@T>a+xI6|LRC|XCQUpW`ELQ7hJtw_M=)XdwZX&XHe_hUx>CF20=@fZmf zddd$$!kooJRtpCDopV_$rH}QT1p5;kiVxfmbus8cgD%e6n#nez?*dd(2F`*mwh@J& z5_HBr1q)Mw=sIvOQuX@!6IjR&NZYUX(2B6!a6>jqXWVZ0d8;9q`5{!3Me8=(cOX$G z=XLel7ILf*;=l_;Z*pSNr^}(PQRrQgnvGX^!3J%ev`HZ+55P@>jir5k(lU4SG|oEf z!vaqALk%5|0JTHtY8YC{B1q>6)<7Ma!iF-(Zjj}fjb`Uv;u|Q+EPp;@ZIm~u7Jvo^ z;6H1C?I|W!DVl?gE#}QEVPql1;D9(%RuSaVpz)lCd7Tw2j3M_8Z;4QN|N zecl@tXvyIVyDE0jWV2avA6k|ppQ+Y3!7f29}y<=dA_H0RTeJ@%bhuqCgOJ|%lH>G*{k F{|A1ko*e)H literal 0 HcmV?d00001 diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/logos/node.svg b/apps/web/src/app/(docs)/mintlify-docs/images/logos/node.svg new file mode 100644 index 0000000000..03768a8852 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/images/logos/node.svg @@ -0,0 +1,4 @@ + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/logos/openai.svg b/apps/web/src/app/(docs)/mintlify-docs/images/logos/openai.svg new file mode 100644 index 0000000000..1022b81433 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/images/logos/openai.svg @@ -0,0 +1,12 @@ + + + + + + + + + + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/logos/python.svg b/apps/web/src/app/(docs)/mintlify-docs/images/logos/python.svg new file mode 100644 index 0000000000..4248bc074f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/images/logos/python.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/sandbox-build-output.png b/apps/web/src/app/(docs)/mintlify-docs/images/sandbox-build-output.png new file mode 100644 index 0000000000000000000000000000000000000000..514720c334c79066b2af523acde0e6e380e6aaac GIT binary patch literal 96991 zcmZ^L1y~!++I9un0>!Px9RdW36n6{mu0?`NgF9_0El#meG(d1IUc7<_cPUUP!6_wp zus?mz`M&o(-|3%gbM0nlpWT^fW@nzc?|TxZtqH=%rNX^+>lVI>vV!idTUZjeZrx6P za1V2)>(QMs%?!ZzhIyv9 z)ZbO}Z{vR^{@YN3_jl3%;fjCx`LDAWM@!*K@cwV5N#XL;Lom%w=9Y?rtiJ#4-E8b& z@?O&3`wxg{UbWu$^NS{XyZX~q74nt>XlWkZdOy0gwbkXhAK~q50qUOzC{MqABSwoM?;x);cxLtBr7o+MrjexN7J~Bor{}kB6aC-qC@pp9|s;A()~2><8L_`f`>$w{Syj{vW3CiS6r_1e48y<(pI5^(CnbObGSDD&2=38`JnN*o9a0iCzJQsrbuqHAqGR^#20X7Yg z@hT;Q2;c!XvBl??wiLL?A^6%bjH}p$zw70H`|s8REYdqXWPPn4-uOWBXoF7m7U;s> zsl9(9XnppKO2F|}a@-AmG;SsP}-@Y%%*+qEjJQmv z?iT#|P=t_bjv!8!KJ`&kqs8k)Bzvwkd%Qq%OPQkJ_J6mq+e8o8 zu(EXhUlY>D3k7l)965bUP3>9?I(6FKBtFvne5WIW6``z322jWm_82o5p@x1Go8p|< z7=dkFy(OGnnW50{(8p2Bnv1gR7|oOC5+z|(&aLfA@Z;@2ygCd-!8jj9m`!WDq^_TcHM*;y z;Mh8^9IYK;mil#`iq7+m@Y)ZfKM@C$bBEigBT<;`;3K{YIQ~fXkb`lqtOB>NFu51{ z65D5T`>AsL!k^nj>68ner!inoZ3wx*W9bu2DfL7>G31YvpG-O2DY5h*; zH1X<$yj*Qp)YQRXzz?9c!K>=dBUA|bNTpjTcC+p^tNX6;w8?HxXV7Vm`Rtf;eThy0 zVlIvID!n?IK%*vEqBJ4P7f=4qpWQ5radWTcQUvliQ&_(+*ret8IqqUdPy#LzAwT2s zjYUT!7F|xiXx&NIpTuIgF+R?hTny->^~~WiGu$4#_TwDBmSowL^f#v6yBbHZdz!a- zrlOF8c{Ig_oM!X7>XRHgC9eH8s(FmUq&*3s+THbTgwa5H*|*l>%TSzW0L2lD|rn{WOUYFUKa%s z(xE-o%etv)!G5X!kk!$}i_^HI%_ZRh_JQbA`laNw8PHNQA!bvj3f_TUc^zw>c!_>^o(h|73of6f;J= z|0GNHUn38uFO}(IxfKEG+Z9&+h7lp1cg__>&u7zEin{oA7SV;~mwXa`ovora)}ZiLn3J z5%J^5tPt~G;OmC}Y5aOm^y14`EQ0($w79=2mlBO)wNoYdvzui;y|~3K@$l1kp+9+2 zrjPY^{qBh?6Z|P-&tx$5d-uu5KUO}G=kHv5UJxYxG1rfN=la$|_dh1SHowDYxT2G< zY>i7V75st01E`i49Khk6!tq(IDwl}K>y5X5-qFZ5dtkkztWHGd0NG<31wtB8^8kq} z^9qhatsg&mAKzhyynkZN;XC-AOzfx$RBJcJlp~X@srHw%gG&ROXNcy{wv2A)egHSijuZ+Fm^xUE!cRHJ0B?OX z(Jhl(+J$0B?_42(zr;_g%(y5;9*L!tA4$wSdW#MbG+mv4tVTILO-@I~<7#Yh^ultn zL}gLzrA}O7?3zmQXmmiG<3w$Dz1x&0r!GS$D-XwZ9T{C8JEpURTVGw*f52T^4cCAW zGbt5W+DdX{n7Qhue|ZhbqmTsYoa)4sF1`RvRxCVFUC-%HDh|$`UZY^|K+a3EKlUUm zFju^@f3^B$pJ*mBvBW!WeT`y4H2soUdi>Qt+U%tt&PS|*Ej%bsu}(7E{elN;_*i%P zN!W}0AwRI>R8C?#ci9_Nh-W>2iu=FU%#td1cG7R6@Nr#?Zrq!f-=$s@8m;-kxr!OKLP>**#of#V;jl1HRjwJ2T#E|=?e&LSTZlAXS;L@__&pBy ztXV;~pTT9i9o)zJV-czbl}MsG2GW73R|17%xdE-;1>O&NQPM`LD59ic~xGb5Xe^U7Gr@3rsy}Mik{=D&vlr$kG z{Et^<8tYEMuMa$ZXbIW2kCUxlpn>;1_>0Ycur~?WGQFDFhAK*gR5GMRL%E2Vs`8yu z+v_4J`8N|5n!>)DR`uEJ6%A#EhNS6H6ZYdLl0gPyrzwCEk5e8pc0+DVG^Dz-tv<4t z4=O&XG}HaLYtlUUq~5!mGefL*BPJ9s_B0i&a8xq3Ih`#o=(%bq7Pwl#$;(hn)(=a2 zbF|g1c292NBVfYmN8?_ZIy28$zEYu1*fG3A9yB_%;HL~VjHN|U#-&T74qJY7ob3=S z)dTF@s!@Lq!I3u+0P8zZ*E_@6K6rMTwF;%MgM$H7!n;i2r=J+T_j>R%j!vJ54G!F@p-SvO-3%)loz8B>M~*VZ`ipTD8&-|g-26&} zmgobL_1x%$Z9kK{;&KTxX1CAU_6g#0RM4^|{?8MAU1rYiB zI&bQK*4zKEH{8}>G-;e{vzDadbI;dJd9VP0gGPtjFQ)v5b65p@JZ{9VTJ32Mhk9+L zftAa(srTY&ZPy#sD<6)^1QHz;pe(?{3{BD|_Sd;|AH;;fyEH6FLb6 z+v{}IDJ}!;-5~r&3Zk|4D;qr2te6OfP9j)Y>*L;I%$({rv(os1o`d=V!#;KZPsLY` zP$_V~R;%FYFS_d(#ng z(jlq_RDvri%R*FqxrBazD7RHolVY*01Rmp}S$E#KU6tV)2q zTt9Ukc%ZHN_JI``FOvJ*Ya?ICB9Idds@B{ye!K!V;$KCrBGrD+ighg`dEXLLsjrmC zM7$_~D^VMyh40=$3|bWUQd^%bNu+QFc!~ubBo)?Eb?WE0QyZ4!c;3r-ZT5D&JIqFL z!~y;3N0DYj8B3@M=EcwLasJ%aY%rcBk)9@26>RXW{|vg*2+SPoO|YzwPNg#KWJluM zlpSa4)Ax0?Du$y~Majht)p2{1KYwU@4c=P~sJC0!2m4q9W3pm&*P84#CTGdPZ(q~x zE$Hg!yo+gwd-ARYt`t?Vy*qy*9Q_Gp-Vvw)Fk{g~OZe^@b5?UOg3q;LAB|1Re#5mQImO!q|yDg z^io^!f~Nz%KgY?B-JN=(C+vNkKk)Z1=52J9NGx2Kpva5w`$=qFSGqt;sDLe8;IHqc zGbRQ^ZA;}Amz6JlXWyh$5CuHHXwi*!g#3K$HMW~5nOY0i4R2&YJRAISWoDEb(f66w zW%JuX$hNtjuW|>chS)^;hL)4}NRc<{lVRCH5n%)#y)4iuiexB`t=5Jmz0r8-XJEvon`E;I z*R<>W;53EbIoFY4jzTwM&FDK7Yr|_2NtYFyrz<9(teRQ-(o};O1M5p9&b9grS3Sh2a;n@_vX=T}&F zjmwY6W&KKMFB)@b?0AQyUZQXBznEb6sRC|9QnC|-HIEEKsn|KPTgA0xzK-D==J)a6 z!pUiJ=YneGNa|VjR4;$*9+nPa`$W?D21$(lrXG2YpiB|+;cRxJiuJ#zpgDmn%AXzN zOlS7E`DST+YDZWfMg6T2gG-b*M&D7H=T1gq2C*`K9X6Ha0XtER?G!=#UoubK8(OLY zmU0^xgY>FjhEG)nH+zmRUJ%Z5Zc!m^Vz6Gp$u1V zuPWUMA4#dk-Pd^_6?|#D=%tmKlplu777Yo6B1>xZH|J_3SyhRwxZ=s5_LmqHpVa%z z@KE(YbxFDiLF&T78J*tgW%BWyzYgEML6A#xO>6*jrSB8!QP4>xc1`mpPC6MIiV0Sk znVA&z#r3(8!?D}ZEW;)Erc&@9UWN*TS)Iy?F*bXH&3FU-6(-ayH5}E~>7r&PrCpve zDtHpmvBV$jTO?fPT}cXhf*Q}tS({JV0uahrt*3e{D(ZU~HRPI6uuXJarl9L8nQ5at zeEU$OB4yy~v~{C&{x|=FZE`m|L~$M|+eF9LUJg)E>?Cq#Jw@EbzSU=5jbXp>Rbkn9 z4!#;t1#A+(q@qrN&`EaJKx=_97dYHI-^j@VXI5ppNc6CKGHU1=pR38+fb}B z8i9@Oq>XIRacR=kfI({<%S*gvME?l~ykuZ|b{#dMi9}(~*-lYem9F9KU@)moPAw|d zKD*NaAFZV7xp=IROko3lkL$Y^i>-d!T)vn75S2@AiLe8?ZVM!e2H%S^h=bH0GVcF# zoVB6iN7t4BXV3)Nr^LLU#5=z8vU9CJ=JI8=iNEq42XGB^p9;Z=ptkG?2B#rX=DhlC zr@bwG51Mo>Mdp>-y$^nLGg`mr3o%uzH>PX@7uDMJT>Jp}EH7M;a@{qy{vy2+aHkM^ z+3n+JWPx5*y?;AgGAA%#aBWh}Bd9v4^CekS8bjYWEuGAGpJnmY5 zWoQ?!4BA+3!F?I}pidVc@{m)t2=B7n@>Q%0&U}HXnQ4v7a;URzb$rH$ja8Lje2usK zkI@aP6O-LM*qKGgm z@y=%<25YD`YD27%aYv~f0W6Lq?~67QgEAVTr^DuTR_#oZUsJVx13`t`gKjJ>I?)4) zJV)CCF5#S?*3$ZZ4oQD0(@9gGGpY2ku<%kM%QMGLiG}}^` z6Q)x*vk)Fh4n>+ zd0@w>J!3H(V~Z)Teln&p%PwWx#F3-|#S1#YQE^y_M)L zC6qkRIee`d4DO@9ZrWecQ<=2ej~G$dzq%lF{sJVfZIip$u1M_;6TZMf9Sh-_DfiXh zPXE9@n*QRf|LC|Ua9f*7&&_yhx#Q;h1N|0%zJ^IG%7C%MTZgsoy;hi%mKqxW%H zt@k6*57JZB2H{uU+_`vZA!GtJaWzq-MQd=1wezIh21e^kk7*`CddVW*ORb7{1sy;% zA;A;;Qi5{*}l6&e=rFZo@X|Vy z(S&s>rx`zfA6MB|mI^FXl?q-Zqm>SduYz2m;FJotQ>8SV2f7DpMcNd0`$`1_Atw@s z&gUG{M=0avAr(0N%RPz ziJ|9pmy}rjViS|;Y9SA>E0R1Re%G|vA}O6afA9gg!J^hK@B*D`L!XTZMvrbt(hKVfXIUFU-dxiUhWb+1lYx1?(KjEVrgFAV5TUSPAb@I6%6Is#lmm)F+ z-lFIk)E=_*k-X2Et1UUyZ4-~+0PSL@k46JpMdDNV!*~oQEh*I6)bFt-q(Hv+>BNA; z)eY@RV>zDMjblK{0OZ|INn_u;h)tr&`ig@eMK-AEF3Bo#tL{RaJ|&x&=uW&%V~ku* zmTvVHeD`U8@6grYom5=Yb@*0 zs8j~ zQI+c;k1_d-lYGFmHuBYv2N&Ooc9I5=1IF_VtqqPVqFlI0^!G7%g=^_hbnF?6nmZ=q zm-8t%Dh%E2YoeoXU>Hfmib|%3K+CXe-id{x1X-=EL~F&>5lZ-H&Hi7(7rTbcTbRzv z?JgGsxKzLB;npUld-$TRMbcMM1t6Oej*=pR z3FbfaQKA5Be7(;r_K8MGD^syt$UU!Mx3`E>THHSGS&n(i+hy?E*@J5C@VPdZgs%ex z0AYs}{_BV`5Zf zV`WzHQhDS4wD%mU?(WzxGIm*#q->*#O7U2`MD%{3rTzVaw%2dSIZgc!w?!pe{9918Yu{`557gB>V0L%MNCFw*wix|(=3IoG9idA9jSF!F`&CA$cT-D*qd z)}4k5nZ~s&5nJd0+xit=8n9S#;yN$&&_VC=BV>y)vrwF5x1Y&s&S)5>h*zYM->e2L zE4*uOZuj_=y5_~h$3^O2!Kd#;c9nG>iILcma2Y;9Yz!An;cal@QJJW+NO52wv%Wnm zWi3)*dq)%6BgH8c-mm}Gs65>HA#4OB?=jj@DnK`TdII0SzeXRhQii6$8sjW*q%Tyj}r3`pZhht;G)Vj<4 z9RiHbSZeLUw9ZXDC6`ysy4j5DIh%|vNN z$&JW`T4y&>ep1u5P{8w<^f9w45758D{410vEw$D~dq0OoN{0m#m>X8nR4=z^;2Blq zDRLQ_EuVOGylqm<5ewtHh-ohIMI0o5>Zit5GlE~4T{m#!jYTIOG}#Rhsg6Jy7nQhk zeeV|Q9{ywo=%zTTZYAW}Rb*yqM+NI}8-$wIL-Z$XT)B zU30eJT7ifYpBe5-pDdAwsoBQk zpN|s!0pWdiynXSE*@36v;<(d*@naK{-dO~^TO6T>x-inT1`LaXU8ak7gQtWdnTia4 zyqTcxoZTZVVa9Uqs2e#tc1rQ4kw z%`sy4+YNLM5cIPro5G_i*FWlvpR>;4h~sBQl_N1`!cp~3mH*@C@x zyi9jfoN*RSqiKfC{`t7x_1v^|klXaVI*|p>dY2%#(ed-s%~BR}N?wUX%0&9eMGUbNeQA+mZTu|CQXW|KxRE68&a$i00gg{>5vrPU^{ z=vjF%^fei;I}MV7zo1FQx4apC>Ef@4VKf39;wYVq6W=ZINS+HgC~Gx)*}(;OQ*@!$ zZGNL;`IaWP+bOlD18qm8_v(K7RRROS&JbA$nL|DXC4%FdHDRkBWQ5V06@QE;p8AEKHpbZb35<1}r2oeB(YI*6CFSU~SG!C9ZgBwM&# zXN$-D=0OD5V|7|r9nWb*uZLQj>K(OVy2Z+QzHGI_@ZN6eib@3TW^)era7wz6kF!{< z8|mKShc||UnHrK}^#&tv1i&U6iNNNVLxHPyx#z+09Yza zCjY^{eU6ZMkp;aLbu5`j3Fx7{G1!5XH)f6~=6R{`+$ob+be-FDb%%;_m{b`ml2{9c zbYS&*(XAh_NI&JeS@kcf26Pr@#Xl$(zIS(As#LF99b^Y#)3{?Of*eVWxtBomgR9l` zfXnI~a?WohJEbDr#C$^ z8gx%z`BqveS}Zi^nB;?El)`UzH5Lqc^sE5g>Q;Ek*K|r6+tWo)W7fyEBMwXa6FsbG zsi#U6%PEEpz(X+pC{Mege6St}j$S>O{)ktknSZXwmgK7EOxr_1tB{IFWj!Bn^PUz& zM`epU%XU!lzDEnvB$$7jlrG9-hk#z4LZ6!ei^V%2%9hHdhP9Q3^2=3A3c?xB4-|Yte^b3>^J+ z9YVH1rjlG1Y=2cn^5~L(b*m!l-qcx(TUX#w?#qF388r!?L1hx`msoXtC51EM8ONGrn$a}Xd3JoG-XDliZYiJ$M-pci!A#cIHA*rO=5hh)^s4@iv+jN3&eYl}2))=(CN z9G(RbQ1fsPWlHG8$@^KNSU$(bm^3Td8lm1xPS}Gp`fa8`_Lx3^kY2jT+O|jUji3|v zNafgJ74p2${4ohaB7lD6k@Ooo7n=nJusXGP^msAENXOos<>gq=Or!b2&UX~e+yFSp zt!ps0L1$U)!jeD8YJp2{p1C#O;-hzjr(M76f`s|soa`q;Erw6Hgp4d!KA8Tgn2esP zrVEEu7Zd9{4fSZ~7s@ivH~4i%Q_YsQqP}XkL%gU2J?nK}E5tt1>F&oe_f2tJY^K)8 z;7bnl+g8q#zliidJfU?St0Kjq<`EdwJQu?^6+ft|GWD_3U;YY8C;`9asSn>t!-@1! z9#oSZNa0XI6$bpYA#_GqeXbwP^HCG?T*aDlo_>||+)Ux|caomd85dyXaSaBZKN{O% zHYi(o$2sGo0Mg2;SIERP5$H*0V}X1d(s9ooXrhuB`6UA11)!&i+89=JYdOk==oRT< zV0xg{+=cIsTmnoAd>!X>1+5gck+E8uVtzGG;y<_Dz+$!h^)-(CxZ#Ld)8=kOOvgY& z`^R7;=TpaH>VOJUd2#&ys4h!1xd2q={~X7Dn;?wvl3h2hT0yIB<;{xF_~+KkA|y(GNi&@RyDjaOz=(FXs|f7TpL=@ zcd`97Fy+EI9~%R;+IJN6Wv!eOs5FB5j;K@ANsXfx#5+O{-~5ygR>tUgbX4MU{GzxA zRmY|^s3+D;yh^%w4V=c0(j}xqxYF$W;5Zcw79YGHXSe#Rq&oE|l00hnGq6v#`ivCi zCmu^lf9wM9@HuH`F;k~*uii^7ZP>@KjZjGb;#cCo$CGQk-!y26UVAj!w9|Tv$v5)k zRnx7-A2D+s@^77v-)J}oP22^=b4JMLWQlJ6sv%9m$Oj`F5HF~k-1Yc!uw1N%iiTK7 z=P=CK_+c6^2hfaMdA4W4S!$&}$lg-w@MKXO$*Yj{&h-8QnnhFnlT~}Dh7xJ@)67N= z%xoaDN&DMu&D4zf`2e?79R?pSv9tPKqi*mcGJ)iriRxt&EsCu;Vp%ZaN@y57 zA8rp)g|KWXX`b~m6^})IAVa=6?M+y_>Nm@F86ePMOFypU&{w!-AITY0G|V#Zgd_v) z^UccmxBb-aWRo)I+)mUhrm|`}GQLpF^|JPOxNWBcCE&johhDV&-J7ICfc!miq-Jrf zk^$N68#(-iy0eP*(!k>3ET57`yu7@DH`jNgo<_w=pA*xO>_W!MKP}BZ4JtYwnD{xD ztXQ2;-xg1&xWx!{ILYy=(I>JZs9mh5l>M{)=hXKXe66j?0?1vi89BXxbZ`M${u{|kSCq+e%NxR8RT2+_vgg;EL%5_;(WELs z<0eGQa>IWhw<8HzgQhtzKM|Dbv9PBP{_gv;-`Mu|Lx4VuVZUDVCM<)A>^)~=NU?J+ z`v^F1Vrhn_?@y)3O;~n(ifs~R8_d~y(U&&^(zUd^9}E&^kpL+T?$%K7T<@8IjPI|700%CEE-#t>mWX`{ zi+h209{k9sY!L$-76Qe6AFqd8tOHHbZr1t*z~@gKK9hi>_t=>cNlz>##L(Rik0Z}y zejT;-Bc3qn?s2A;+9y*C49Isl8Ya^kDfn`oyX_nrbU-!5RaszR=iHqYx~OLLk6;I) zIUFRid=Dx36BuXXLM$2YIa;m#3u zPgHkiYEjZA{fspT!q%XWDhskglGxu=ne>t()0{=MUwu5_w(=xpjnv{j>!_ElFlf16 zQZgB@cQj7${W(_*ZE@UtA|7gQpBEVy-Z2eu8bUX^_OD8Hs|4(UJ`YqtlennC26nINS34){TzzHcD~+wa~87j zt!HL>uTisbaVFjn(pWLnQ)MR*SX3D;C_QC28lRLga*S3!5a856+#GZ4e?Eh(a)MG$ za!!jY$cSN2lvD{#diY^s6gAS!Chm><->oMc=1mnQPOE(6_Og(Kz9WfjnNwqt>5|hY z=;`#+r1sMW%XCAHm7A}t6BxzDr9^A3ZR{EIT>A}!nVDGCY!eUl#@{$2Q5FuCqe@H| zwQuGOF(R#96{*VA{dO%)y0M~?Aev&Z8ro8zo}+%1=$k~F-|`x#QvI^~wMB4XUj}+q z_9OPs*3zHNprBt+e}VR1buOB7V^^yd>~1dUwq*nV1tDBHbAHT1Lvs& zS8+jxwj%D?6H@kEm4N%?H6s2!R?*%3ioq$75&;2##Ix~tzA8kWIC*k!^QFSyj-iJZ zHb<(m>sNQ_x<40)Je>^ISH1^APggu^4{g#6+wB4jz}VA}P-cm6IZerFrpa_K$`ol_ zQC@?JlJ3)3b8!;ag$?CSaosAPj2E#kfQ_?K0hS*NEz8J`Sl$30`H(A}4J()yT%_sI zSU|I>bAQ!k-{qH)_h)N~NLN`}SCa+mR;3YdZG@A4$1n0u;nmZ%*?v9m0~C4d$VI$l z&|H|NY^XGgVRuV+r0j1g@T_FWN!B$LUk2KHuL9bSc`uPZ>yJosn3?TQmMTyDMKJP* z(~fB_y=3`I!9pKD_Q$7C`W5Vqy4ne7^ap&kO{{JJThq$ENj$p+sGYD}y+;AGJ6~F>FCdYNa3K za?J@`+aA26-cVl>__fGcC01v7JJmW!t9rR|g4?7fN$h$$y0Q8?ty3Xrv|jXZ4|PC z0r7)tLbmoj^A+k*hxgFc$<+F*NqF&5VLVeKNoVIa2|BDHQ@kewFagH--cEjtS)>H!cKq2q6M7i5o!;v;aR`sk?BT^_MgaX_~gNP2?D9+~y)LA#-_~w!WsPiC6Z)3Ar;(_Q&%( zesyibs1$w-f5i5d(d8P&1F0>Sdxjl!_0v^yIM$_<3tJj5q{XM`O=qaya}lm^ljmi%Q#*{0g{k-+lmw$tC!+P|dEui|AMdB#l&Z$_Vn^%n>9zi}16 zxFLW^h2`r5bU7yW(+?>V-v=^d(Z2jXzAroT<+~1lkI%2o`^x`kMF7ze)~nPA(5Nuw z)4vDUe+nBZA7F{&5rXm%RjhtL7agqVJ81pIGNg02z8nhGtb746>?c@uM5`vV61In2 zjgN#_MRiOlVsuZlFWC9p1CE(SUC3_maGEdIex`3u#W-N*GU0{s?;)hRNADq9$1xt) zN=XIkAi#t}@tKP5c#OlY^e4`CR$GP~vcXIc5Jd8}=`(BJFxA0o&oS~XtJj;O6mgJH zgW4DQlX8Y(nucc-#f4+y6a#5#Ii10u3Bp1WG}`MwZ!O&%rW0@o+?-SbPd_;ZJ*PQr z+?#A|bPtlbkgdM_?maT+ASTjqyY}xg%P2Du&6`+X9LAHqZF0+(Hxo7vHGS&7=?b|X zp6PTDZur)<{1~5K;aRs#H3acnLK;pc)%5jWB2vA-M5Lce{}Pe*B!>c1st>7~yH#>6 z#Jttt36kSy)kL8$>oUX$(iO>fnpiPXQrZC*D2LIQX9^>Tv5rNvcj~I0p1j;RVUV-K+>_c?EW>an%k$>(UebQ*m)B0xJE zLZ)qx39`(JUXGo-hz&3c=-6oRS-3k-INV1&Yum4W&jIEHI1Czan!fiBMb2+W<+?dh z`g6l|NZH>OoKOv9v^oZ~_-_-n`=k4w#8E(=A#laK?9%4R3$@d!^o#7(G6ZwuDE1}~ z5E~b#(S}F9;?=(s^a*^Dj{zk!du%Uz`LWe^&zKpW!=f0qix+A7Vkc|w-mA36|WJKR{f-GzVw2J#~R>qpeh)o&#QJFnF!a32z28xK)W9O+;jO$ zPAJ+IlQ!xQ) zCOkdt(K{WBQGphG>j+J>>55kC6x>#h(k;kyNccICaZcKIm_(=r;KlHA`X9WXMpH>r zEOv%uQ)o~r>&E-M<1c%X^qtx#lw47wd^sL*BBA)7)F;3 zz{soCz8DId2wWJ?2|Auz2C}RY44*h70&{7 zNt2@3^Gr0sI$!Y3%j(U?KYF!KJMQXVG2ft8n0^Fo)AW8k;~a!hV!$vsV@ROaVxGU+ zz*aq^eB@Dzke|zqIC2Fn$ZOSJbf8x}0i|u-g}R@78xYFa3v*Lxu5*BoTFXt0hZ&j7 zI~u|SM(W$8_=8SoT?&W=>Kc200Abl%3%QQ1^&^ghnaAOeDeF3(2F4e(y=X(kp+A>+ zzz=*E;rEVpl))7lfU;3E-(Qsem4RRuV^MiB-M&9pXz{MIy1xJM}egUh(Nedo5W z{~97YW-UPj7@I8-mm?KaL`I5%VDdTfsr2TOSRK1Qb?A54OEz4n>RvPLZ=>CC6r$}^ zILv21ltp4dEbVlX?vg|L5P;eG;3S5Hj`;!)*}(`uXCc3pS}oPcv2B7rKDCb3qwn$T zi=9aL>%>~;`b|w+8`<`#!CmZf)V$yN3LZ7$RjS2S7P= z-OA3Y49(zt>I!m5*foqMiSlA;3p;(2BORbz^Ml?DHCYhlF+mG;L6Chk6#B$+c*Vt*%P- zr!v-*(}iqG5W*fyx;@@o!2k(6ChkyLI;l|gyt!o+1c60~Zv*E`_qcragl`BKJ7vSx zcsM(_wA85g#Q6(yZ%^ZHkY6z<0j7PdGz0+G76|@IpsU{>B@VnesnpTg?wIp3!)O=K zX9s@)d8t~~DbggBPwLQF0Y!Vqi5!Y?OOhGtN+4!?d$+K&%|yKrYBIMp-^XzQb)ipI z8Bd4M)0?8dmt$eCS-4LUDurD9rMq>m)O{i3G?63r>xTR{Ucf0{;C9lJL|oUG$fU#F z^nNnefZCMLL+F@V?3FH?mJ(7mRePYD1%q=IJRmOhDR#fKR7R-I#Bbl!jJS3?Q2ZrT zZ+Dnir}#&I|0zN4lM_ANo$m+9?B1Aw8B4}Rv@+gbbG5;T zUe@xaEoqqX*f%5@anhRF@s6-V!gqHnMTBM*l#%Db`O z$~(oV!dDpO9gfnMf}d+&j-^||V#ez{aCaECR1Mt~xEvB1J2ZMvJqmjX-MJ9)X(Krw zz)Gf82l3{?&k8{W9Ak5yEc~om$>}G*_!EtGvGms-?ybsU6nDSKb_h%?y)fER)X8;; zT`2ljP9bj1uH(F$h?|*c+A!@R{HOSQhg!vV(MG@IveSV%I7XH$+%~&X65LGI3r8I) z@`&^uNSb|h#3k~X80H0mYk=!@lidVT?E(2f(g4vWLto{<_8OMcroH(}nz#0vFipUU zTn+ha?ifgcdcOy?X0{||m2eAJcTbke50kOP$nnFO<%x~q@&etTV%ssRAoXKSy+1o<8&V6Zqk0Spv8d84Rh{5dQ!wHmWXvH-(W zm~ESWMMd7RU0km`y6nbNMNl}MydoZX(dSgH+4T=lJwfvYP$HPEd|2=ZHC4V=og_3O6I8AZGN1aK{X?iLlP38#IqejUhv`ybJPFI z7k}wL9&pAP5}ycJC$;XrEVMc< z6anOP-%i$$Tv8H>(|Y%tN=2@b>~{TT>L$4?Dycb|bhBlvv`#Pdo z55ko}oY6F*Ovs_s?A5Ml#ry{cLt0!~;-+cEixctjJtoB$zCRCR&r*DbCX&hNocyE6 z6NM98bV40vq0n~Z#$Z#HX~mw-Kpk{sBar8U&8b(@NEm2U@qU0mowRsF8zTdKxTBWM z6u=-kvAhzOnd361yt9gBrV!4|5{Kh%(ut~z+)44Vn@mAn( zgy3wS_`zrrg{1k&IicP`XCh|BYfH#!m1V~9)x&1UN|o}Ml-g)I}841v;p$1tSjJ4R#YPcs0v08qomq` z%Fr<7;7WMpnyo!# zzd=^V@3xb+Q|F3gNuF(M_N>*4eXNgJ=v{FZsgCI`X4I;J_V1d3BJj&^L^8U!D0+k| zVZ@?0enVpJ`vTwyK8F<>%aemqj`E)&bsL5Q+hZOKiZ+e-bJ7Da3vsL)YP=$4|W7^8ITgqi+BZ@dJBlt7X>_JelmMePjYJW*B*IOB9$jkjtD8g0K2=Uk`i zm23I>5#O+5{z##K+BN;vKO-F0JGV{8^Y3rZ9d0;Zd1Hc=DFs1~VHy^foTrD^0vkNq z!>%R<)4JW!oXAK^(dpAJ^=pz${4@?zwL~t{K+csznxmXv25O z!cqYkwkfzSLV8F%SYlX+x|Ie$;*|1>a~!w%N7KHv%oDE8nScj1DRVzvOF-*C_SE)o zM46&n%Y$8yRMjji-o3ogXIA1N)Mag?V8UxR$n!CkzSj!j$vAM!-_=q=E7uB zc{Kqe79XzjT`aRn3uQiwH_39p*I`m16WU;>$X%7hrdh$wuIhVTU4C|gNI77g3L0Gi{0mP#mx z8O^|{ouvtCwcFNgsboN78Og9OT8)uX{f5t`Kl`eSe3>v2s?ag}Fl?Yj?5O+HNd)lCrTnT9debxIq z|BtS(jEZYpx=jcPA!u-S*Welm?hu?tgS)$j0Kwfo!QI{6T^e_HcY8bM+su$Uy(aLSrrwkF!rsB93v*AJnp=J@*DVE=i|@+yi@&;#3-aB$C<0jTS2zsP_X) zy_YG>a5viFotg3&9=3lFQfYe7g31DaL6Oc61vux@6?1)EG{bUVhXN?Hm4?$g8fFAD zFwfCd^mbXS5Fe)+$Q4Tzyiz}U@}l#C3IbX1-S#+CFHL6U~#>Gj}u*ZaB%L(Z267QynSM(#q2&*hMUcDt|hK>XmEek zv_po+hrM~&Mr@Tutf^ehAn+dU2WK!&B8N6j*lA$pq(NU+s-&=PpV7fDAa!J5KV$PY ziPbR`|M{cKNM*$_DKSSE2Lr@kM5%{qXrJ_*vKHF6@Pb(7OhW1okrbg)yl0$-`vh9x zjMBcA>cOsGq`GEtkxdQl)RQBumvH~#p5?q>+?()o?3Q2yxM$Lg&gep4De!UN(w$ad zNw|su5}c3(^V03cR1o<^-}jv8VJXnoVU}1*zjERr=D57?IBx;IHJLHm#l|G{L}Bm`f9iNP1g_;^ zEEFLq;{-7GtGOCJDkB1vqcm%@w^OsU{N43t&)67z)s?Xti2y+aA$aXU@%xQi1g?2! znje~YIg_gSH07b@7u-di&XWr7&!55QDmEE7e_I7$8AAuz{J41}6Hsp0Cn+!dEOkyM zlfG$dNLg|N7DAy`_s>_Luym(x-S(0-cm@cz$tSZg8XnJ5=Hy27DY6eTzVGBhw5V@S)(I3!u%7G4hhNBX{ZcDet&Y{B`L z@ZB5`zF*021!LkY%?g_ad4_)Es@}#e)`>EcQqSV&*jui^j>(tnAT)T&BhQ^M5KjvY zEL)qNBO=S)7rgx|zJWsIixl7r<7ehcKEMKx&t*WlKa(fFr+zdr{rMJYzkR;WU?^F3 z(Q@>R?GnoM7hbg~a$zL9`!~Ewf&*CuHtQB|AeV0lD>`%tJZ-ixh#Yd6tuL;zIQJ~= zY@?S0c(zR3XL;An}fQUOh#Yq4LrI<^%T(*h2Ql&F#QtJf0^NSOdZ#kr$Jv=@${uW^ez+8cLiZwFb0^=3g&PI+iOIl_wa{KG`Vijs=twe`w?Z-+>g@t1%yACegz2dPgIP=VDC>-&qqP-TKN( zk8>q}*u`9BF&E$es2;hnpfg%wIAZ*|#Ws5|QJ~!2q>C|Yl1qGCY{quwM-@fvdAGf( zd_rWGF(I!hFwYkefU>c^9IvmP5p>djv68YLBf*r6xRe3y9}qJ((1# zloK-nm3+P6ETbWylCK`sE9OP#MFy#~MUorB&jGFpS#%s_MSuXf-2~iORtb0t;FZYd zx?}|gx|ck8Q;2|Re$73q=fnjO@OaVzrVT?JGxL`lQKTmW^YCj;W{)s6KUw4_*%7M- zC0YtiGko9cM#`w2^SBXarwxpHr_KDIG;{Zp_1wvSwd=opZa%$bugct{lzB_1QP+-q z|572D9Fy^OqFw*VTPYeFk6L*G7!gm_WgmnyGlI;gt|cDjM}<-X^QC5Q zhYEW>fD)IbBHsR}S^34oWHFCgDv>7$^)qfXgt$=RpDaroLSgyLDuWMgkdK(_N7O%YmrVFim{psXMsXZNAi9MQqmmYd^_GHReK@ zUk(>MT}q0tk9tA<;p+dpLS z#7%2)la0msCCmoM0GyuBtKLF-42GU(7nJ(aX`1Hq=z&G#W~i_3;qlU^9;TGYQlUa| zHcPy_^#d=xRUB}5Jd(%ja+Ki3EKdX#B=hvsBV$@Z`^T{p^k`M;CHvk7@`E-QxIi_= zOw>ld5J|r<`~v!RgI!W-J@?By7WYzjY{Qgm9~X?+c>cKQo7`-K2k;uhwT$Y zmv!6trZ}vtIh$@#)h}V7$LJX*E&%K0lc}DuJOZ4&y`Yv@@RHM5l#poysAd1M=*Hna z_18LX%D6H%%Tpx%tY}&ZGSXpHJOsz1C3$g9F*cia5-G`!3``lgQiWRKkP)u@<+K(jF~F#gFgaXsU>8(R9#idm<=yA`PxAv~BCoQ{V=V&570fnT} z^@4m>=8l$g5V1-^t>@E4g3B2fz3ewgRcpYP?bbVZ`v*fyOSw;R#Ih_a3R zeDWryswm#R|Eq!p=I$%5NLD}ThZV06W?`_{oD)^&WWPC5h1+kr-UOwo5UYHPHkbDR zRMxY0jgU#jT5Fr+CD9xnJ|||Y+A-42{;FDP{ZYtCjO&2=<5C*WDUy#}tR7G)C`VC) z#!v5tuw9<)p?juGQ+bTd`b+gHIb?TR`bm*#7`%9``+M-cif}xNvuHA0nq%|UI1*Ym zCMhSP$lK*&DH4{NTt&{RSUeV-7OrZ{QjaU#gt8c-#MaEbr8Oc2OL!9eu`j*B((`Lo z`*lIFk@2lTQNoz$>p7A&H}0iuniqPf#tqIuq#X{#mF%2vkJ!cBtLmYVepP|$bO_p= zh@&Z`u|0`r5}<8BEFkiHjhzaBeudeMvwK39)YK525Zy^(YvBs(y9IECqP_8SxG4=* zyGf#QX^@A#Iaf}q<7%4>Q4{rMG0NM@z+8_)F4KRqXz_TmMTCvheJfdRG(fJxu*X5+ zD{bDpjiDi>7f`#KLCX0))f%p<;*nWcQhU=s4-zUyeFx&E9tV`2IWPxurSda`RKc<5|rcYqSD*SubL*&sjo2>&XG%i^=5^LG#N=^x#?A$N%>e(A$G zT|?iTF(Noa4JI;6gCb~DuS&$p#gSye097m)RZqLNq>)m?#1Yl;@(xZh4olv~Zy!~H z8d~)k)YFF%O#mO(Q<1*1*l@k4TD4j*=yI7*)mC5RF@sK(bZqe{WF*Oy0PI(3$~IqzEO|Ji$Byv%WPQc2eHn%53BRC3~MhZG(k@2_J?X~)S93ksXgDxDZQ&=aawoX-uu zZalOj+s+fb!#a&2P=Z;TCV5Zqbs{sWTeLY{F!JXRVYdeF@lC#1S^U%UY!Q=U-n1yK zMES4avG&Q)Tn>!!VONnvq{jmc7L^02wa)aBXb4e&5#C%eoSK4}q6A(in-5wJQvAdC zx^eel#G)k9S^VU~vi~4j7Fe0XtS5nZB+YY^*|@wUm#xrkzRZw5Mql5MwL0{DP^Oex z%{idxV$qJ(H{WM9zl;%SaJpKnJ>4c&9DJhr|Y2zaiAG={r=JuvHZfN76XAPjf#mWtzD^CK}rL@hoB<;Sqa{V^1ZoM_h zVil>CKAYClCLAR1#5ms%D z?mSNSEAHdB@*qk>syKR6T=Q%7uqqH4&^!!~TQhp-*-+xZpOn8e=ifVU`ZEr~UNSVG z_e2rNEU9x$%0Yl!2!HY&V!81$Ut%&xgDq$K0~4h8nu%L3oZk2(Oj5#=c2to1pGb5@ z-A9@Ee!=|}2!O&>+PZqSMcI+XI4-~y;Oa#?mD>q^Q_(v7k`+ObriVF``Uo}Y?(Cs| zue&2296pi}A=d<8e47mm3aAp21d`EPO^a)Ht$L^6$HBBksvHZmRFEJ7B4CbEfsUt6bHA@u>u81v{FriAjE4xHi z59Tg^G!0bJ{f&k*cskQKy3f+@yGr~s_+n`a)j#;5NhS??;KoK$yeH`$hCj=4N$KHd zIUOGyC6yjL&KiQdk+2L%dskqaZ~^ioZG;J+@UAYojZ0+7%}F2Ju*;O(KdU;oj>?g9 zcCe|l=;J4Cs9X$+6J|%cP)XXXm_{&g)?cG?XS3`V+{D*jt4yGB{?r|WDMP7VVkz{V zd;kqFN%I2J0q#8qP`S9gdTWVZag38injv?vc-bfpQO=D$+9Hut_B7EKbNM|?1cRCI zyAqgb=Q&RT73efq>ulW)$sFxWA2y=_s~zXMK$WiEFtVgiE_2~Tpwe%ON;lQ!3gXl@HiD74LfLX*Md%IzvJ8oKK3+JsPaak-ty zx8Rul#tiAbXv$u1+$HgFeXVJ3%Uq2p!Lf6-if+AqT|oz?y62PkQw1O?j^0BiBMj#< z#d!15;t@@3Zlz*5X*sT^E9(256WQ9C*c?am$v0)y?_p4_{i*sXXA{Id1pBgHmwk@d z6ku^;OXc&tB5}OZAZi1FDsBE1O(FnZYE;HDpeu5>vtctvvm<`O!f|Cq$;xO#=tD zAAPA6cCAp}0mG?tYlZQ2?3*Ni`WcqzVNiy{azqA=azweAJ}L}qKt&1;hg`O7A}|V8 z$X*SntAy~?1M9GI0xkWuS=2{uXN5Vn9^oux8*fG46p@Pr}M=GOy;tiY`ztC zNi@%t=}-br1-WA|si88_OrGUbv#b;?he6M#xt1~0?O zP>+EM=K7!6+P{@e1WA}u@@PP?(}+G=`x)$dC}g;=$5CQJU2tL<)-Pla)CM0TfEX3Z_o#-d73a# zGL0`I%+*HO5Ot_ig~4zxj#oe9C+kv|o0%GY&#NW;W}Hv+Xcks~h?2e6qM5WSSTQy$ z9G5Xc2QdNv^r$W+ZAHT?Yfj*w>0aX$L>7%9s#7hY2U8?fAFfoL&!901I_Acl*yk%| zNzK<#^S)QA5g5#)F{JJoXg^wPkpV2UWF><6gHPb!QAvOp4SRpM;RQgLPcOMI#~!N0 z5bk#32bq~tdoX>Ix2l9|6Eo3ILOecf+gj`{8Hpz9a!5Q6{i z%=f>)z3@W;cUxZdxOBe1KJ0Jb@Y(4L?EfzQ?|(d40gk#itMw>wzjYA)+Wt!Sziax( zLRb8VU-W0(H(C5T^qMKXJ3DReS>32t%U3WlJ0^ZUL--C)rlj)=?D65zKA zK^*(6RKf0Q9)!pc*+k+G^|ufI^BdoGL#ijo41IJr$XCfA>QH!B4coUK&@z_xLBS!`g zG)^Ls@ZIHsB~*zvLCQ34q-Fu(Ad1YqUUrGU>z8e6Z2B~<)+fI!iyV)P?5LVJ^d{Hq z*x?jTaW1x^Y-;q8e7k4eW17~C+WHRN)HSa$sYsNYZ}=ojf35uyyBtJV<7HC7O7VFnYA__2c^r z`e}l^N9U0__L%Lc3W-$2yN~m%f+{K$@y-L%O$>&2KGSQOEg)A(EG9^VqqNe&30(4{ zM)JnS#?#AISQwVzJ+D0vl+hl7!FmDHIly3)ugr)sd!Pv6lRCF(s&<@ zCJv+)=~=z|eGw5M_&>dU`;w3V(&y`+F9iL+4nTy}hs=NJ(y}czyeDJ%Ql0E<{zf{2 ziuPvnR4Nk<*LA%=3x?fVuf=7S1*<|b3yZzd(J!R5V`2i?9=l4owN74mXd$u1<(7Z& zSvOrOjZ!{GemW%){LL{qK3A>+ulY_(`Nq*Q?<}cuHx!OKPG@TQJc9HdYUl1y6o;b} zTXSj2>Eh(2%~oF+u+gg-Yx>sv-7HQnP1S3mLk|n~t4FRnhb^Ak2+$rXUpoi)SS><+ zHq968CdMQbcM zVq3p~Mk3PqPQ&hCRFY-*WRN0X9}N0nb%COAvmuW{r6inkZZC_~_{Osy>W-JgK{{flUBh~AhkX8(cYBxC;e@w>Mexb>BK-jgtKHo7I zgF>r{RVi|`l{4nPHWmplx7sPoSzANoxY4d_?*yOabsg`6XvxebH&{ufW{o~mJPD6d zF2`4Ed_y#i1H0N%HRDdND9p8Tc;ObNz!ZG(WtfMjES$tyT%D{fj44mIgfJ5~qEGH} z-zy`61oUpezL~%4!$S_H3H`e`3d24&)9JdA57GH2&<~#R!F(AxM4qci`6(H$?S(Q& zpTby7D-VcSv;m6SF+5!=ZwUNHDBVNeASZrMTWhyknMI(zMnVBP(uF;oz$pCH6 zE-6X$JYcuZ4XuDpqkbvY=+qqRfj*pUHuc1DyYu258f5@f8=oE-iYSf^0Sz+>-?fF> zTq%b%Q6g8E>(hnx#$$RO5*-fNVT^(?Q{%yin>3|d7T;hzgBJL;T$Y&39BJXndAi2Y z1HSgbXsT!$B{tS$Ne~i6DM4GI1|wq$C4Vyc!-p3j+bzD764kLMbJ^>_*^k;_a;dk& zrNaq1FCbnGM_@`LvXzM$=z~#_!!d($;?ONLTln`WWab!^V_J!=BQq5aIW)ID%J4*n zegE^s{_XK4ID>ZLdMvhJi?bGR{V5kxf0M7M>_X@nn05Z#nmsizS#wAjmPQb*Iez;( zVWg^)jIQnst+O&sIFd|MY4hv(9zd`?krgvrtQA+BueN3>)`C}fp3NknHI7tgx0Ty( zf5>fGH|>e5njJIT+_Uei=^B~4Z=}jwuKf6v?dh{A8#+06 zT>h?B14_^@j3XbsbDm*xa_#ywH3xUn@%6~)zKZt{nqxDIqj~sIhc{Lo=I=@J&s+X! z1IcREPsD2UBTXX5YtNxnVFOD2R(OtC-fmoK!yi}jhUdW_TmnX-S^TmnPTE1-9uK`X zL#i06I_JTXAX^UllToZW+;bEPeu(&-e#~5@P7nIX97%y@UWis6W}U83I4#C0vG`sY z;~z$s!J%<<$%N(+Ou}8?Z_!86+TPfRnxr^MO1C_$lt4nlsoDu%A)HaRkRaegMsa+m z+28AT+iZLMBC!-YWE#WKPpY$9tXF}6J~F|x;YN63^`UjD^@XChuZE0~)@-NGYrK-E zL6r*RX=y$2ifEkJR1W7!1B?pBq(FN5_$sJ-JHlsX;Am-oTyYg&_dnOV_87yKIs5OS z@sALETT62?n%&8RG84z2wPznrDq>+jtUp4z+|dCR5*=OS>L1$*B(=4^-?A@)Nz#qf zqwKrgc^T8gLt6ZXb33X%8@U0-!Klt8ujn|mR!^y2ns?sj0$JRQD3Vh{I4efySYfi5 z%f2r{d!}=BtBP7r_*DGnhw}6+HyT>$=vtVTh}Wa)2W3{R)m&n3@Zvn1qOymW{0zHh zlhqXonHz8GthPc^csMy4-#b6ckPcN?rGV>~GdVU+_^c(M;$hsXiqKEGQz@JP$)&bc zHchy2mR{oC^37^%anY)esDVB=nMm-eJy2cX7V3BI;w`4p%`E!Y8i?XSpb9W@?8&@|hlWyn)nD*WI0z zA~)l-NgZ^eayv^HkJskK?HW*$Z8Cgb5$HUZ`r2{t&_Z`UJwi~#$65591?9Nm zqblErM_$Eb6j0cr<*($X*yCSqyIey~1JpG<)1~uRl$32W=;7Gmdx6`fFVEP?gZ&Dx z?_~3JSSEk&a2qq}fy+;#eLf8WH)ynU<$Fr;_wc?k&^V6s;(ZsRfAZf#>A#gpD>mUu z`FE)MW22dJiXq>8>8)L++~>G+G%vPT1Kd?8JbOn`&~dWZS?on~n9!4boRIA>aH1$-(ZN3iSx)lkz_w}%OwOg4!by*X=V(Di-!|z zA~tQzo92~9fz0urG`L}8X2RZ*iX0AZ>DkHDjvGRZ*HWA?2FjF;$Ix_?+bUc|=_qXV z;twY8B9CS*zg4}5)xm{|>V|dLVV-8J{oVRMMH8;P)Z%r(+?5MNX5(?w>0-Q`*PdkX ztG>Jn{W-|Y%;bOUkr0w5a+O1Ysk}?dBq?OUU~(+!A@^=#&ad)=OU?6H)xC{DV{dU( zFFj>~#zJ>R>4zHFuEY;G4wpPaK4TK<-LB_5tFMxDL=MfUxSZc(x^r?=TClJZzS9Bg zC6bE$vqt=5kJ9m9#<6fa2&nA`fOJoM9G-{7uaYyz9i{y%TLz>@`eGq0(>V-0LVMaFe$8b#x-B?_iN zc1N~*u7!(<0NzK%MO-zo&YaA0o-I7KTF%(>$~v-yuZu>7+s{C>4&Sf);^>OV?1-$YJNlT)H}Ek%)EsG<{Rpo$9yjb}^X{hL>s%K> zh#}D1U05!2>@h&0lf@h2y5b*Uy`+u!q`q4r)U#A;vkM`O!|{UNa{iDxDG1bH6%+~k zo4rAV7z_S-h;4(C;#L=CO6=S}Ng}8cSm1?D%q+o*Zwx%6Hd~ZGi27*~Sx{Z8%_}e3 z-0^{`9sz<*yRvX;GCxaqhxswvImZU^$C_s+=H0?>3B~($Tf@Xl^;Xz|A)> z!@+wiUVw~h_}g4rEHx@cracxzISAkr;ZSYD>!mY9jB_nffR8WVduN6 zqeaH&Q^uW9+Yc_4`F`Xwc-U~Hx4#b%l$SLy+;Z7sVFz_*-_`VhDn*@a0!F$2%52%E zD>I=?@5r)O?Z;bj#oX^MQge|lA(%6j2F|r*m9Su|-k2JK+i8pdyM%Hok)O)+T7q8f zq-FN&RFjrqJkOEmS3hOaOr&Ufg4ndWWtXtA@sYB1Mu?{g09tASxq7!WYp_> zZ&6pcX~lb!Dxpu~w9<)%3)D_Rt+x~6UxA*e-)ddO@Pv~=`?UjLm5kJseW>AHyC zT4dUw-gx*5(F>qqC2kWiJ6Qm&uN|eRtyFW>6xJLK+jyMq@YxUZCj)^M$fuhVaqCBq zw}2oV=drw61HHUHx`ext%*-JCzzFlIzWQ@Ep>4LzXZ~0^_m+<0XYeY~EnJ<9yOm9q z%#_MDlxbA_kWfwlX~EpKR=Uxyc&*hINfD*LqW(Hq3O}B5RX1 z$R!NBL0$xVmDkoDK)bK}g+1ZtLbH8`5k?HY-F2wVMx9Qdy1tT*M&0K!#{9y==~s#l zM2wbVDRji`?feYSVF4@E#*BLH(nyl=Sv_HRt>;;91Q(o|{g0DgkZTn`FD=fCBa=v6 zAw;*XkNYy+w6!Gdg-%~|WICgH;)8VsGiCN2z}pA(on~}k`=SxhdS*L$n)a7#rIlM- zeBhxfFDBaleQe^BfpZBh}E(<6=SE5v#s~0hg%4JK3WzY+Zn9LCuy31BrAn&bz+vAd6xS_l5 zbI*H5G5`LW9>@MW3!~Gafh~i{_U^7P27^vMaB?xmnC3oBt!?`K?)dRC;%|M`>@kvY zrw+pA9|3Il&JBt}ls0lF*|drDdD^jHdEt*GvKb7`66ayK+1H@&Zz!ai*;V4-lWTGZ zV_t+HnZVv?GxGO>C}6npAfY0{!jDA@^jr2yK1IlFR9;YTCVBh5OPYQXXpaTu9|UC| ze$Lc$&H~vy?&&{pnh;nl)_y1HlWU#gnN2Y5Kua+LGurmEm+C72IzkE*TN1{zq1~~* zWk6l8c_YARw_m@C4hS0hWJCBr)aSqFE>N-(1R@c5iL6o3pIAXP+-#(IXA}ZyP~MoH zeV*Kui$pY9rAqe@URqOgNt}2cz*W9Ko;m@Y+;{BnRov~p=wepk=Ck`3m==f)uo-nT ziWPMirvX{*3p_42tz=qszv&o0y%mIlI1Xtg<}~|0DEqtf_bZ|m!b_QJJL0ClUFUzR z!#}!Uf;~h;FOkVvn1q1eZO}`?6*7nt+7o|ldY-k;knQZ<+9fzH;>|kIz$eIea=j}U z4DRXA{7bFx*j*6s)y5@)hRTq1Ml#Gx*@49K4w-S zI1|Phj|jTZj{5KS@njg;3bYbItITt8f*<0s{1`~M?jch0bKU%lwNE&3IL&Veb-(7i zKVZ@0_K4@kenwWr42Q^gOFP3cVkOi+?QKV*=I;&A0G~TwZ`g>tzfaZQj&Mb%3#fv4DvR% zqNZn|EYzyS&1;5wW9mx3hPdv zY3jkCayo5xFxxCkz}X7EGFHL-Z|LJ0#DpfwicOUa zG)7XkODYhk;|A@w6;}GyL-CiOp0t|xa#n$*p%s_w{X51G_1`*m`2MKG*@{*i4Z~f4 zDthe8fSO8YZxPDj@kd`q2k^??MB=c1{J8>J{#5Rt50Jka6`L*EuYL$ex?_Ws;wo)1 z^>8;Ydk_vuhr+QYk8KB^*Oh}l3E8Kg69@Bm9Ra_gCRc8_FYE>`MKylg+2eiR7VCzF z6a8Gv+6}jFp1_12o6$&o??|W%PNr|4;_UOTQoh+VdO39Zp~{g{_Bjlnr?cJ@Eo075 zi%=-vZiOYcQ&%nQ`OIaY-cvSDSi?-U2^Qy_a?MeYdQzGqulbKkv-sOf>bMWb*IHI< zy)PAe{Hrn^D==G+(shr2s&Jc9(P^+3h&SUgqfK~Xc_mGkBp#V3!X}IrKC*oo^09xW z^BCJ7sKPF48{-~2VrnoJ85jW04?^eu$~_NfG%SOPH@~0*2Xx`WI#s;|`hX}Bf%{bN zDVnRpg>U-j&y|C@w#)Bl8g!X}&XZDwqRt7-Y=tZRa4TP8t+vq{r4>`8RVP?wZzmI9 zG{RVV1*^*Ir}`6=pwzQx#4J;+b5$7s5drAxe~8T=T{y?QVk^-As^;~d?pLaCv^oDi zau8p}F>`-AUhL{RHyr&r{iRT&`K{m8;pcW(vi@6|g_~L>_e+QY&v08EZK#~sl=~In z%s)AvgUA~<_&iNx<@B&a*wmW!=6((1V=fe9#EW$6q@z93p0mgjmk-YoOqP6*Z;~tC zJ6Hv!XHl)4b)DA=o=+epy^N+&Mip?a5!knQtTM|9J#|OUzpc0u5{&ZmgL;QX8v=lh zwH_>p9`MZC5W}hIW#btys%D$)y(c;}hzWbH9~;(|QsyZX8etEo5ig8D=rXC?ta^t= z&x3Dd04!eTuJNoXf=bFIYpC6P@TwZm7zUTO5~1KZHEaa?5n(B_EuA!jg*`E6);;?Y zHzf=};skJYsv;^q4z!$x`Uk;got))Iaa@_kEd4E9R7&^U$*d~nD0$Ih(>@We!da9x ztCXZx+7eY|1k%!F{De==&dP6|t^U}N;GhD1;q#5B!Bo_W?Vlh&ORMcIxQqQs6d?&^ z!TA!XbmjT)PG>g}1ryN@|J;m~6w;M)jm}!aCab%f_xiC62RWE%p131oOy0iOKQH)^ z(9p7nS+t=%Gm@ya_%3ad=;T>#Br%bJ5|rPIh?Mqgjk&te+*_}iW@ES`sAYkdWB6UWYgf@10<$?;wdjrVDrjWr|+dOn41Oyop=|oBD?|7yaj}^>z zr-GJ^7R zqWrp%8DT|w0s-_JIm{AnVy48}M7)=4=6Oa|?TJL-IifdH?fTDWk1sCQz(1Tt^qvXu zi`DB-`X#%Xt7B9j$6hr|)huvZ8X|LP)2e1iuJvqveBj5J*pAUvPzG^vHM@UoI_2Ia zeOT>)60hyLd_~_p=h^H~`KDMmExB&wU|uk1znyeI7eB$Z5LEq%W9Fe;5nU3K4aFG- zt?Mvp8g9Tqrplhiti?d2@bYRT!EnL@$FQViyrPYgh6Y8Z*N5DKTdULovt?)6cv6+) z`J+r4oEe(q-Ho>2BByFv2Rspw!JV_k()v!EMZ+l=QlrGMJ?U)LwmCkmG~Nx$VV(*6 zyKcdTpo8JA)SOw+oA%s~34?yhP95Pm#b3W#rhr;(5b*e@^Q9}2W3NkczvC{R1SB4m z2F=srLfKlca-IBWTls8&2!C*gfUVSQbzrO!f$MWN;AbB=z#}Y*+iV`@MU~XTB9lUw zF)psXOc*K$ffQUSHaKJ&*O4$1U)6+#@xx91;dGzE?tn$%)WwQdlx5YQN%idF;@$NS zn`y3_dPB2P*F|qOA8Nk)cdtd&H9TYIQfTQ}Di-s(_%iT3Z&EiWdSM?j(^e2-9(S{Q ztxnTvF(N`}Z~J=_7233YqrL=|ouP?@dr53!PCU@(ov%hmDxy%r)-$`f>tDmlA(}{slL)`87*|6LXouXi^Z<{yKar51eeX zA597aK)Q}9QJ-lD8&!MzNqU6AnsqtaTEJzQu*}OhkPYc45lR+ zjb07J0lPs5`rP`2#ctvg3q)@K0N6wz_$fbO%qVO!x_fIy5=oYFa*{u-r&Li@UTCi( z>Fup$+)0W%JmkpWj0M_-(I^;;Ny}M|NsNv=d*=G1rjqoI%5~Fl?2vN4hDKvG0`2uS zf4FlrHn<&$zyQ-|<>F+`DKOXm!fNkAVUv-HTMIM*>L(`=GFGSd|?M(l`rjkrw?a6()hD!FOn)%$eF+{_lAo~#}72OF}_Yrx#@c6iV6U^)jiE z9K8>`WRZPf^ojfZ& z^sfOR0k@Yj)$7#(Nn5I^T#+#)PU;CXR&)^Ov11Sjf{okxfFL1Ay)zvD`HMZm#qpfv z?Rh-61BI&nZb2p7(FFcUnNCkvSceun;1dY~*R}cJ#u__baQk-qp z;y%$@tEei~l&Dvv0)VZ_sVr@oR_L?+VNRvY6G;oP)K1bKXNXz{8z0d_g;DI8zRpL( ztLrkCTL`zY$|jf9GP(+0&l>_2Xsf%h#Ng3zM4YT0wyP~+gTj!j5f7aGecYt!bdKBT z6~ua+C*=wCu|15C8n;#0N+S5GJ+@a|3zJv<2`m^x6Jze#LzJ9&vvF_k_jcxc)PD@FBH+!> z$(7C5$9_NomWrCO?d2O+hzZX2sWd zA$=Q}TB#P@*w95A$_FQ8{pc`B9L8(j?RwwrfxEorUCqq_DE{uvbV76RUTL-<{&@S& zBA|pj8Zd%&+^R4T*BL+f5(PUnw!eQhGK^cdEV4n~!C9A71!gmiDy0l+N^HtFRay7b za+`hV=D{p#YffFNT5``;rsv!$i+z=(2;vo(1AY{>lG8(>QXIG<88$tZ(k^%FrE*^xc@T!n77Hd~g@K$FOQcWf>br zg69O|+@89ZHBCj5055YTk>eeIVB2;tQ4^fG5tO&qjNFe>D`tP)@?Y0=1r9MiO3l9@ z|9k&O0J+2gp?MN;h_A0CR8M9WHatwd7@_IY#p1c@*uy?nj=)yo(7PfPwr#~PN5~JU z_e|s?LG|zP;>i_sW31S~d|LD1KN{V?zgUHy`F{9T>uG5lptNA^G8zQL;+&yS1UjL3 zDE}5F_qq;g<)S?iP2@%;8`6>pRn%3xn)1B()it)+9PVTSXamK)wYkVtx}Ni+!C@-| z_W#MWe>6u+Y!Dlj(ZT1-vzbL9VRLoWD)*+e%U88FeaUf{!&5cpxQfN;=L;F{1QLFS zmk5$Wl%Qs9O3_xTPtA#@62Y++ssi}&OAG8+fmpEV0vg8|$_qb#^%fiG*r8{E%Moq- z`D>i?;p@W%oxbhhVRw-)$Du>HCw+$bi)$eHHhcCgu{3A^&Q@CGpQh3JiU5P!bF=FH z9!C!+MwlfN|4+oZ<+J&#SHn7MJA72{M5bi0f7oSV>7_=#m@ZLoZ(R0l3n0F)GWdR2 z%MWDw(ORi%tMiR!tm=c{WM`Pql|lC^%(jeIX7fh7^3wl~!awGGf`$-d{3~Ui+ny9^ zS!neL7{1gbCo`ho0^A#(8ywi(HjM+tQN` zPEv`8#6cY@o%Y_R-b8BpJ!TX0_fC_h+7Qh;h$^zV?Y1s97KFgSxkFE&ZERam$=m& zj)EE-E!ta5Z2@k{OE-650&j%et{nDr1N!AZn|Xp?VLkd5030J2rCflTEe+hViQ#rk zN2gW4A~&0Qm{jTnMxjaI!gcO@ZsO*q0@G9kzaK*e+nk&NF4V6rxm|8v zkOQ7qcBc=wwpq7`NN1gqhVJF&>s0ChPOrvRygHzi(l$o~^s$1mICTup2Z&i?Wr@t( zfiXo8PEIOpQy=LSPmxbJ9nCdL`op3|1tnZ5)3)O|TQA42r_8}_}_+TMQ+U0 z>8Bj|Pw_mz6Bqm9S40Wg4}(a{w^hyf8s zk|`Rz)!CU#m86Uey^$(5jZXrz0U|&;@XoKo{$bouGFBq5o5T}Lcd_sl0A%s3*Sa&F zPsO-MFwE}O%-+>I`aO8+!INLC)F~2FBmy<$3V;>^!13pVYokZ3s)_!~tv>U{UUh@l z9D4e1{!ixq}@zRxdoxYpo$8!X}Nwd(3xg@E-Tl|M@p+CY>c2a)J*2Ghn4R^sF@t&0)8H zlO9zZ;Q(Lq1H(+kI1h2P4IZKJ08}nI51geWoP;Gt6SDu$a0u=tLZ?io;U%Iu+RC8d zM@k3@off^f^^VwtGG-~^<+lMcg(|H4kcM}53Vyg=`8(t!4;V8UF&TTYHsCGMPl;%b zmdmAM?AqJ;jqnb|`EkK>yHi!ex`qWfa9h8sh@j4T$=?x_fagpZ;@G!!UCKf_;7sv- z(t`zeEqwmjv1duoYDD3y@lN`Msz^`m-RUC}=j!?Ly z)%`R8SGqS0I(NA)Kqu*1TzG4C?1&PO1d*I)fWEYK4%hdFr&W-w5^?>GQ0 zy5)uOHR;iJZobDY+}tAqZgzJfbqxm()jStmR1b%qEtdF?_HMPDhpzBS+7|R0>_JTA zp)cA>^5bKg@<|PU6ZpWS8SkZK<2i%s3z@SV*&11F$mEZgI#5PKalo(I?YqR#a7EJT zqS@h|yaIlL6v5!^R{8mrU)15;g*>WiY(@fwl0vn^Ez!YjwX6_Jp4>jnr1=7xfNOQt z#b&>l_g0FP-LnPFjV+PMq-i04_m$b>>(q~~Xw6*aBZWX=p?HXfd;i&g{+yl9REIC* zQS-htFht!M=BMp?qSGC7XFe%~O^9`Zlu+GoxHiC3`x;sh1}@A-@z<1^8JIFr7QcBT zh@o4TpSJcE8kx~x$QZ+=id{%~_Hp?Q>bqFqS6%%I-Cya3qD#G@V4EG4L$J}%0yQ>* z6(neGZi0P?&6e6DKqeTS0qB2c z05$^1W`m42%v(Gu6XcgF8qH1#er!;gDtn43`D|Tz#QGH{%jL^haNn;}fC`Vd5g|1a zP1G9=S5Z`LpEcz^^wT&>o`UF{$MSQ2V0JL>_n>W=j>5ru1P=7y<|svAwO&0>DbGL6 zVpRVhU1uFuRkyW$MI}V(knWC6cStu|Qo6glL#10lz)dRM-Q5kF?oR3M`WDam&UxeV z{R_C@g3a1<%{j)nfA_uq914cAVZoHzPonK-G@9z`Bh{6U{QgI{{>)2(F=DxLa1cRC zF|gjF@2zYP5D0O<0BN~ASFxaZ%;(y2O4(|@mR9R5Ig_MK_`Tdr^ijrI?qcbiE!n$} zty(bzhDO8APY2=sXymemuhBS5bcLc7F#$|hh2mI`6^|(l>Fts-$4twetw6*%oUL_?ga53C z@m=H9?($(hB5Ysiod_gHZCf*KJAb;Y@{htQg|P^>1&afidI$&~0e@k7}_=DDGO&qxR@! z($`=)4MJwg+O|Z(SaIZR?xl{z7HsO@@GJT|u6Ny&wJtX?x4KO>hFN_Mx7Q>xbxR0I zrT+eWs<5?kzYd|^m58+4Yy77+c>~lYFv#+Sqiw_N zuZB}#5D{X?Wl(MK_kfD^EwOt(TP>Q~OPcXaGKtKxIHeK)kO#Y~O9q)qw9J7feE1vGfkOM zGaoapr`wYNB*X1DqqzexNdJVuVGxb{e%N$7f1fQbfFKzLln)eH!HleZc z(%meqIGFZRX6IOyOkqTC7Zw2oY-}Gowd=M>UQ=0o!=2q{y?TAEZ(Sn3@q15HU$iN` z^U&EUJSCjVL(YAu8to_oq9oV1uq}xW2n%5pyM$uSz{j%>MZznTQt>gen#Iwjlpk;4 z^r_PMh=yyxQ{RXLmK#m#yfN#r{&v3|>!1>U?Kz`vSpf-JoH<%+onavp()2)sj;=;W>*9fEPOPBZ+ne~26md;%o5@QZ-u%4g``?@95_>HF$4*lPPzW7l zEb$GyNAB0Aql3MFaJvS)!+o)#Z>O&ob_9PL9Hb`xFtO;$^im6S9jCBk98p~g1%Q_Yn1P(N4x zyC}fR&$>ssF*1=PtLfFY1@Z`aL&w)6flTxVQ|9kC>s9C%c)q2AgZQquFaOd{xe3BI z+I>9nDO6FV`FmN?NCi|nC#hDI^h*DGsQmopPqVmv%ZA(482e0<*7ao4t*pA;8RU=VkO_szqy0ZF^^=YN9)xGOh46tYA+np5^_03?=6|@}@-#s=4VU4xpw+GcPDySr2B( zx%xVM@p%bg0`-OnWB;BBe7%bNGJs1s>#!*jC1f~ayFvaA=ZVVW{oO3A&e!xTg?h#J zNsYbr$3*<^MSO43Ux~}9ob^I-z8rp{$H2LpS0tB@8O-JriO2uR<;##iX>JsIG>nL3 z&1>GqBm1)nCL^0sIBeManLlO+r0P6n2)J-2p2S^FOj;$=d8oBl>g>lSDY}hvMa%;8 zgzO&9I^=Bh5Xt~%FN1Fcty9(uu=iv8hel4w7VDM2zW3O#ca1aZ-u*G-GlgSXH&6vu zY8IWUMBpH|Q$b?f4u=~=y-410f3a+~Fm%B9a492Le#2T|996xcVH*PUFU=1=XgpUB zNPgW9#iS=I-Sg1Onk0!X?i056`PJm7 zEShtR6iRF6T8RQXk%Tlz;)s7z74ro0luW91==BAWY`dLCW=uE~>0 z5!Pciuc4b2xIS1AOV(Xpsq!DaDNkgBKiTGTr7MS{7@?I7+v@qk?D)L3aEOn|@LjM2n@TPa(Nrt6ytSKxD8#IVt+iqA8;8cv;OEw@P945Twg@)Z8Tr z{&%gqgbu@qz_&&v8SI2pF-DZ;$?y}fIOPs=r&VFEb%9@iK(B=v!Nhp(z890fse>Cg>&cqT08kTUKY)TgunmA*5Q09$7J z0k*<>#hZOjaPNf7!G!{=Ho$Dzn$cYdk$i{no&i(f2aJ2Rdiu%L-Q2kHHOWW6H)xdTzD@wt{~}Lvo-1;8 z-*+59nG_~{E75qk+{IxXp;n=BL6znka?)|9wmWSzA{_8>%HKeI{iJ5y)745i04zZD z8$yKzP5tK0Tb=8J&s^~is|#GdG5Fqx8Q%ML!X*2?PNhVOcZ2vnlg`~Ormz0&y&!(^ zqE*y=OxDNPYX0xcGV;#0L#el9l~CcNwgbj|pSe%wtzBmqT^Dp;e_qYMPUb4ton-MK z985KTv|^Vr@w8+kyfUqJ`A5kf^|t2lW%RtiMvWOa<)!kB1y!(2wyyNtd4Wr_4exYB zFd^QV@3Z(3ll3pT^*aYgoADMwu$t@f`?<$=ZB`_MgZr+`HJd0GFSq4M=izQ9wiDHT z760q5dRCEI{j8-xsk{+LO+f|+rvcKI!gqdmYd7P1tKB_SxWo!EnJd^Yb|qxVkN zKGuB$o6@pc<^C8L0bdRNd$LuCAuvH1edS4vjzElCvm*~OOiJ@OD-?r48zEsQ;Ck$a73(d+4n>90P5uXfAJK5d)9Z8H@_+gx6UX5<)@+yE>`Z`+ zjEq4Zn+5;_(yRdoIYWxAv#}QRs+davEugL<1DO@DQ%7T&?oH2~cNcWZ8&r$sDQb}13DqmgEzFGTTE@44 zL6#V_;)!a<23X6S?OlgjocKH~C2z)a^Ct=f!zM|yq%OrCs{<3yi9!+ZLY@1o2Of6u zQI@!o%cQnHli32PBLj8n_2PGz-cQ4|uG<`MF+pKS=WDYWo7--u8)d88zh+sjIj|BS zMbP~lR?UV{Tzo)JY~EUaX|l7BXXw;Y-Q680(~b}a$YZx&X-5c`3Tzf1KPwliQYAxj zX1D!OStagloLY|giEwE0?|qmwlQNdOG&He7Pg&{zOJEP?dYRzu7LGR-s}qk*R}ro+ z2(7%{bCXZRpe=$9hFyqL*EeuH>?O=)O!w7EBb|D&sRQTM^Y- z%?HL&i-XLPS&RqXaKv)kUw3g1Cg;>35APGzRDt(fGOgkgS05`f1Q~WBa^i3ZZsvKb zZI>>VJ*t8VZM;Ob#inx~R-1SM=<=<{PGbNtrNC2h{0Rji70QiO3}LHXK}j({nr}LM zQ^la7&N7-!p5Id*%83$u``E$*zF0o$9G5o-dAwxyP!$#tDf6Ai!tm$=(cO%@f1FcH z9H4lR0}<^lBs9tFxNE_!<2 z4XlP)+`+A#T~qkwoCwJm0!LQ}nW&TVq-HiF>9HQF;r-X#OfpAj{B3vVz&J*vXHYy1 z9Z0ObT-^6zo==;m38QTx8uWQ$W|e3OgS2VidYx39@n7;-WfuMa?(OSU$g_!dy~s!&6#l{>V-l+LD;KR*t!1LzaC~FKbmJ|A_?U>iP<>4Xu-FYR2=P# zEh0ar{st!xwOO!k-Sk!be3Mi*z&3!nBEmf)kOKwx%e^M$;26qfW zY|7{T1e*kcjZlR+__zvjI79*%$-5BmccmZ%hMh$}z;KX`9SKK1(~y(@X6&JuLZZ;s zMjcL0uk%~fBKdilyvMrv=4Vh7Q^P7Xc3}t#XKIP+xjeq@Vy(&gh@vJ2BKh?jw~2{> zYm?q6aw`vgo1C~kf}u-lq4Z8Sd1$f8XDAf;NWWcF>b$ z^hW=g9_z=~pyxN4*Y(Kky@!&WlkQ&CY9m00#8Qq?vWRGY@$;-+9e8q9Q8~k+4~&xj z!Af88C_BEVd5FMI3px!KpwiOs=C5~X`2ZcZmr}lYSow362Hg9Nidfet+ll1=sp*N= zUTd+Kmk|c)PPsnRM0&|isDMzshC`l4DxX{!{w!H%NtLdZ%yLAE6y3=PbDU5`HukP! zcNZ9uqC`7gZYWSJ=*9jt+(7nMiqp{5n;diJSnP~AD)0)geDL_*58g-+g|PdN)@<+d zb}C4J?*%t0FE+ZUdp8{BHmeQ`5MF0pN9p=}lwd)a69W}n&9#Skr<#T6{yY%bFV4iS zj(wgB!8RUM3noO*cLmfEJeX|TZyE{^UF5KL&eU<=9@dpk$dz%agG36Ansgs z|Es~Zx920)@j#3BTN3u2p8^83NdfBk?p*?qyb;Hr#-JnYE#}LE{StMvA1!t?p~+_m zH&Iei4114V$4duRhxWh?A7G6?1*t+(JJw?$w(m>~V855JJ5@ISp2n8xLp#+cdl?ejlBeE|tyWJDQE^L*>iF>L=I-p61{|qe_+D30jgzbk9;0S*FB ztjlTOhBq0k1)f>vy5+N4ZIVV}V!SXVAQrcb9O?7KeXBjVw+4+PyCd788%z!Qk2Tay z7oj$DwGCueSPhMQ;yU5H$Q#T4OnA=z9lQ5PG;na%+6%3eU>ES&Qme0`XQ>W5-x#-P z6s(DOyfjt9K8)?CN}b9i(&%xKQ0)N&#lb8hB7(F+unf`ZV(VplGK*rbx=*xG1>9ce zGk#)Ya0A^!vFs%Zc{cS0O^;kP=zgcuCE2q{5iniG+3stz2(U<_yYNu81!3+U=6 z^%v-pg@xnAMSGKoj0FL_N#_85Hn4?%ky!ot5ore7-+62v&h!#m9~GRu7qOlDAi%Px z=SUs-wzUrc*)P(d(3mD)z-4-tcMChSzS)$|l6-A{+WT^Y=F?0_;-@V|{PzJV{g)Q= zFJ!i40V49lq947TKAz3gh~BE+D%vK)I=8{l967#AmCsoue6uUu)UaYicZHLU-P$|W z=S~z>L|pnZ&k$~MJE#hZMHnoo^pn+5u-vx>E!+Z~Nuyzwund#|IE_@U%?=X;5xLUG zW@CFQZJeX<^=Sax47rO(v4F_H_gE9p)zaBBy-V3WBuU8g8rb{aYaj`XMW?AA5bA?_ z>MxMvOJdrktGB+}5@(*J0Pz;QoCdakeQ5ivC9BCo&{8w6V~d^UKW&+fWm1XPiq;nwSFdmrgl7c{z%N0BTT~Ygxq8Ra6o&sAmJ7aG&3I;Ygdsn%8%V5E7CjY1xNz=l)fb1)?8_aGA=S;+f z>pPTa!CF~x)yO(HSo=)0FvWn>E|TP0fmny#HH|fD)cu8@&&nXYMDSS5?A*|0FniV9 z`7xD{C3|T$EbqwV8BuyfM-N~o>SHq`xqV^^@PhiUP;(a<3o=dh0lR=_cF|p_0H-F= zG%GID>|nUC%`7$Y&~ne+a(jQ9nAx1oIZIL}s`u!%rLDDg3tD5&^3{=nS~s-0=}fN( zEYJ+SdM)8%5L8!a+%1qiL-gJkR_?+6CwscxHn2aG|KAJa*{F-*edzBHTr{ov-xwT6 z7{cI$Pr5COjVZLoIo<+g1_5`5iy_(l3hA7Xch5eHrUm{y~?uWS-7dfvSq;{Z_%jXaMLL&-p@wp8NiThBuq0mi`J6348=cXxw&X#kiS=+ zZ8oZ#f9!Nr237xH(9Ofp%-z;+_DOQ3!gkxYpG`g~$c2q=eD@E5I!ZSsU57_i1r5jD zAPZ1W5uR*EZBb9&K33qUZGU4Qy@vRnAAgnG*%LtKNKx1RPy`)yGqL2<@S7|R%t5Uy zsgnQ6E-_vH*t9D9OxauuETenyCHJu!noK^)WO|Q%mS8G zZ&Cj$)^+Yo!kN@zGl{cgHWckq^-F08+W z$ZaXo2RrKY$fTO@zv<8TD96HsYL7^}jiUzDzNT=IhmxT7H31ii&qrEB+|<%T_71!K zTeu#5DR;l7TfCQ&2%$j2K)uiS)e7(_!NN=%HE*wxBilc7x+`tq8_PyEHp~rTvQp*CRiwwoAVQ=wVCSP%mBL(wf7VQ7jVE-M5 zIwU{Vke6BHj?SH%?r+%=oy_ZN{Hv4<|MJx{tD{i7n2)& zZUFoU>q|}!_S93uhk>o9-}T!}_6MHtRkrV3tg1I0#kYNy^^Y!xaz7ogT5N}ORb+qL zvy+Y$Ku>ht%@C$4RnD{DU{t})Od|04Az}O2ZAqJ$??sQ0O zndu&^4e5WipZ`tu{8&ka!tk2#&ecX}Hp=q%UF&GA1I-IOspGP!Q?Bs6y-XHzQ8(OM z4DUH_1P}<6Iq1wP$Eg1_v~97$(5DOgAb0)QGoBYBmO7rg+x^~J-0&#;6`LWWJh!Gda^cs z+vJHCApJuuXh~!=qicHw#ndNg`F5duKL#p@~0R!#d}G ztfIH^@7eJG9G$;{iCpe{kBe)ZBO6OND|pSM#cau?)$F#ERSrZX8JrB#sIi#xoW_t1 z1GC%=opBen<`wYsux&wY*aV0&fG0{*JEr{l`tE|u{rp$f4v=B{th58_TiJ$sn$>)% zV!&vl^Ez(xz3%7I>R!WLzc-k%J?~U;2?`R1B+49A3X^bB&l25I8Xh%EcJT!(p^C0Y zmvR=7kcw?Z5>I|UzBrUEAQUMyK!Nx0qirg){uv*m4wikpz%!;D#X zbob{)M%+y_R^RZDWtB{lVHHorr%G94tzX;%wM3%!&Z%US2o_wBs&xlzq^YxT@V8VZ z0|cYs&@=X9JymG^L2i{(=GBGkcVK$qnmb9qFkY6o3ghPOF_P zC*%u$aYBE2*2F=ELR(CDjdCx@{*Tuj^2OBYr`2ZS#iwisITqa;yr#K{o|xJ3WDf;j z**PqFlo4607)o%6sE-ut2RnHN-v7dn5PyS2rtACty)BaY-7z-%`YeEGs2};ti#x?L zR8oL?0Zex_CcA;M`58d!48~D1cP{mtU{SGX?-=hGD^cK;d6N>m_Zh|>^5F;hOSGgj zyHlBXVQ!7dJVy0@pK$+U_ev*tS!3xY3i}oCd90=duxjt#LUqM|BbeI&@4q+#N-a^O zQ+wX7sV*sy))B}03F{MmBJ(VZ_yH`#55JMx6R*DCd7S0Zj$@8gQTn@49rVuU@>q}D zs0diM5{i9JRe&A>DNbiS{tIUNT6Y-|tSLl4wAT_*iSO>C!R?I*T5^`dH z#!>M3YbC^NMsHayumPj7D#b!{l>lWF!8cVlunVkb+I>N1C;_%0(p~^iXap93aQ^-u z;QXKaBUq>yW!(D5Nr%IptK$$~q_;;212qCz&W2oli?m6UmRf6J&?e|3tgLpYb z^1uE#3XE<1vj|9UizD|p3GWMv+be*4`w>6A+3Lfy)^)|cA2_g>GE>+^UFJ6da7fe) zC>cC&!VCYq6mQQeMfB`%Ldy9?{yiBx0d#DBTm}| z$wV%20jwf`(tdlHl0>Z!mjJii&;b{xwlY>I0wO<^33Vn9FO@ejPPy|A%A`?j1J3dD zJD(T}4&wzBEk0KbNHv?)>>KVg%x8TV;GoOV97;=#r{kUDNz{%{WGi}wB%n6~l5RRw_ukO$zVa`nCr=vHLw%?GOFTQ^Z2*d@zatH!FoxBOQ6 zLIkjU7q+zv$9!G)$*8MVl}in5961F-KZp*O>JXlW<)Ue=VJpe4W6ADZG+y&)JOP(O znAp6ywA3$FJxv3T`>$euaQ}b7O2_)O>~L_4U7KOs+O+c()?`@FC`G^ zJiE~duy+$Pl^*J~W&5mSCWGIAgg?5~4hVY5y=JnYBTQkJLa3~^ni-R4e^h+-g{D&{ zpadvUQpd|S#CiqDtohiX05O%>(gv|Ey^bu}Czp|5^V7UTh;Chl08i%EGoX8k0@IIS z^}T#59{LUtYHT)l>@GGsa2zT64Bw>;VON2gqfnhg7eTgGX-b@#cHIFh87PqyaH&ba zIyZNEx}$-<>Pkrr9jlii6Hv|G6H1yN5Us1EAIk^s-16u9pQkYjx>LQbh>dN_qn^_#h(L$xKfx6*7%Ga)+BI=tb`pm$KGVh#zrPb zbiI|ASUaUh4t8=+M=4YRS-xl_PZ&iW-)RZZ!xb^fH)^8Y_pk?%y1<0=&U|Nt+GozjylDx@~ zENE9kFa|Os-ZB~G(sOI?ot40_hWR z<1?H~B0t?esh17Fqg^jq-W%i;{k@iLlzCqC!SA@@EPaI91ENaxyL4x23@f^Jax%)e z-o8bogXvYLvHT3g9Yy%REwckW3x^B!#a`AJ)T-j<=H%eGcz>E5`|}l>tgbfP4;pL7 zh4eqJO;^)2utMYV!j*cE=HSs&W6b*iCCYC5^1ZQv;x98A3O;VnwcyY(2mkaM3_7KN zO66hNHo2IMJY{N4EH5qcqB!BM0fW6;%ni%TMq_*=JWFMhyi7-jlqomvmE=>AQ{)>4 zg!kTWTa0LaeB1(@*LqKc_}Q*NUJ?f0VY_-7HBX0B{9g}RYO&`WAytMHnf5>&RM;NW z&s=Nph`fA%h$O5akK^!R-woP`TGBlhDQUgvEe%VdNS3jf6)(AY23o>Q0t;A7Z{1kp zZU{Rl2Vs-KWpOu4{0X$|56{y^%Aj^=RzEsosiK&kYSQA&-zSs_#;7jB{!)FwBG=;1 ze~q3D?JL|Di#Qfc6Z8!P)Q}971lzt<%Y%e1cKeg{($stwL=P_ejSmd(AF|mQzv}{I z(0}ik|NTWeFHneGc;}?Bxw*NuCfqynkvXF6F_li?^&}FD8&6%3It){S_6z)as=xp* zl~=wEwH~dgP~y+gtnp;N=)m+_v8k9<@{U;r{y`_@7w| zUxQJP!_}Pg82$sg{IBolf53jFs=|DV6;<7)&rlE5h6*Yh*VQFu^nX6nwJ z@$V=}UUhDq2u8z?K&C8Ba3xOpr_3b04X2Bcd940NRTiV+uZ4A|v_w?Hmj}b1Ouz)g z?F0VClylwtPvou}gG-b$5Lh3n7(cRyS~{^x@aHRP+usHojhw*(1q-gw`Y<7*tJr8^ z`<@W=C@;*#i2dKBO;5Q#EsaIn)affJ?vbSZJn4=jyDdd`XL3bg&Fv(CtzM-U_nsH4 z4=bEJPC}tvu4i+YHR3+3d*g-l>4>fuN8f`Z&$9P;&l+3uxckm*)B;!@BK1?9_q+Z&E*_j$QA(R2YX|d$P(0c5h}4r=2jMn=e?3$(GFO z2g2s6&kqG%ctU>^`~OBa(cjp3L#`ZZuB4i;=sa+d#1{gH+4v9HHsdam()!Me5UzXM z2v8!a-0fg64r_cz@z7zL%`1rv#UT%*yV8AiNAC7u}>doQv&9uZ+9II}W-E zqIpQuCVPC5#(eXRr8eG$dFS{jA&y+OPni6QDMNl%@P2fGBS^arwz5~Y_!1T8Kug_I zxkYzr$`NDq!G4RI#eiV641dyB^J+UuBQ4`XLe<^;miOyZv-^0S*miUO%Ld*a_J1y~ zWALA45`e=#bvIcQNZ&@qfkL+V)7N=5mwi%?#?Nek$hx06-i-FmOP+BBo_o8?qNlvW z5besMGl9jkYPu+%&x}D?Me~*Xs-M)Rfayd2q|rbe)I5W!&Zg!LHK zOH(lJrB>i;rl3o!oYKl^2IpjR)4ct_Sb1F)Ki5GZ3%Nj`*<$<^AOs{{?#j)v;xARd z4rp5}bqLAd6GQ#%wq#2NWIABqx7<^u)j7LiU2Xsd+!Q>Op7ESvb42cXxJ90}gcQi) zw25&vGj240fQWWXpWMcdIkzKRkusTB_%{DA&9&5`;!sKq-2z#_Tk3#O7yDT6BmFbkwrI}70ka;|2_k{hque?<-PPJWkcQrl` zKMSY*X9XS%N8U4aUbN17z z?@UqiC#_#UzCc7oWVfy~K5$UZzj(t@^r*=>SfsuV42OQRAbjSMwb5%;m%VS(g`_*} z^TLFg%60?2fbv;M(0%ZZAW{$D7@csQewk6ab##-f*dQ=wIvi<@2RyrY!`?)sPHXCB zK3ZDS|0W=;8r8f?vknAi$uqTTn3*JEKc7D(0-lbzmH4g z^u63)XpB$dmK7iThrDuG9`SOZ#yp%=@_FrxwMD0lPeG?bhF%1OA-f4)!z%VA>i3dc! z-FV*dy!9pSgdUchc%b}6&~WLNvj$ZLyV~?9FXud2vF)Y1H3v9jyVoqWu>T&x{8J>+ z+yKka+OT) z-+47?+aK1k`pBg^^|WWk-rOCC_PXO0wX}7axZ?v9hwj84=6csE?mvLy3B1b1Nho%P zsZtUd(Z!azHlcQ!t3+YMl+C3qo;PDtQA^06kE`0z?~A%o+`_#-DGeUT4!S01Z1vj_ zTQn`};ZG*h^PCLO{pLv8mUS&Ox7W)Jet>P`x5$ycnhc0J=<*PVozb}ll4yR|ts8nM z$ctu^-NUqo0OY)e%T5q5E@^9V1TfBomkbR)VPxb?&*?KUu{1)3YW7TXExatzE8lc^ zZZ>zH6U~c8k$oT_DO?o5P@@21^|%O)FAg7gxosD+l|x}VXYPCub+QxXohoRlE6V2X z=9W&Jm(5SCi#lBb+YT~!7-s}>XN2=BapI(J51*!zrm7e>5*p@ot2^=M{JeQ%xx*Xrlb6wZ$9PN<2fTI zK5t}v?3xLhqDtUm5_ur|&XDeGl(?a99S6=mR2&(1H0B>r%7T}-BTGxO2&#i`Y8h?i3N zWJQFlCclzqU!4tJO?6#W#PPLuofC;1Hj$J@RSVT-V0biLu3d;?irHeFigXp*P9 zsvX%Q73Vu)DpIeLr5|wnl8R+dIZ+eJZH z$f@=P8s_E0wRamn?!%m8&vgD*vNOuEACz!)9hG8Q<}QlAlb89w zc_|G}6CfDH{)39vY}7Ht7V9PzXc~S>E}SX_7oCvI=1S>ghd7kPEr)xc*H^Ps#Q;9h zAG1vI%C#J4jn&CWr2!Sne-w8!B8Vd8VqP02mLGD}^&)qMNA6fMO2>f*%MrPoCk<~8 zB~t1fb4o!Y`PT~A_}aDl{BfqXNF(2EVSXUa_I`j&C{;BgAM7tS#a_z1I>DW5c7L^r zTAvw{7xmqC4BN|nsl~O%YX^AKOaE-Y`|%XsHqn`5QS$3}|KkFM*8?m;oGhF5!*=3; zwntIy;uN8qoXqW7yN3RrV4{)TP;|Dy>DctpG^2pCBY|1sb$FDZkc|IHV={@bAHKDX`OzJmlw2Vvv2vyYe+kZ9w?safLZXiWGuXW-Ms9+=y812AO<`+y1F(7 zR+;vFrwHa;@|!rTiCb7MwlByixlZO=Mdw~_V^yY@#?R}&iQ-7C<`X11vc(2vZ+}nA z2B%XU9wl!ajk`iU8h5u?ZRhLHh}HI-uq$PO)wz3)d)__>sxCuFl%y1hPFQ+gohkd$ zuHzl7(R)i@1tuuQ7k2C6{6~c&|hF$J+TBE8AW%?p!P0 zeC&xopUs`lU0iI+1orl2z1x(V&%; zzngQZCPwc}P1=ZA9g=|X8a5zEGPUt06R|1(3w$?IYb$Aq;&+ey!b5m)w60GwzB)`g zT}H#@mgB39&o3KumFr6b=?%{HP?4Qz+g82=aUT<~wRs?AD9^lpB}I>R`%3rn!B?nJ z{1`0+ujlxRYNSI%H|woRzL?tE48Q39c=X1fr22WN&BB`)pz1z3%BJeRAP#Gf>~YJk z92!s^&+k8Q-0cU~z0o2LH*foGm&=(Yt3DdHUyiDl70P54B~2;RA?}|c_9rq8cch(BU?b2Ahwy9`0Q80a>Br4zLu6m zrMrfk1;y)Y_7emTN%(JGpWNbB5t}$6W^=bt_JoFW4XTDBeo%}4uwfC1u`pwElwBh6 zws$_#rrG5L2R1?1_c8iM8E# zPVb!>TRKi1wDxzMCHEcHpUwno{?O?OhAj@`Mr>KDcG zQ}k5k*?z5JfTV_KT_NGgX{YWHqKLzdMutI|YLEFD^*LL9LHC8uc^DSfg&E9GXjyfp ze9@6VeqJ6CZw_C>M?ikEZ*EPzyE=?M+*hIu$NVbtbP^Mij7_fP4AwJ^y{?U>mMtqvSe;;r$=ZP4?IDDU^KVjWm+{w(d{dHmPc8enrzr1Pez{ zj>kY45}WQITcnKCht%j9eRISZhl?Kfz;`%Z)90P@rfV{%Rh-L#`yUZ><9`R&bGZ6@+q^yciC#msF+;6!|{JtYIxcO*s zr5KA8XpZcBk36Wu!_%aCQ_UBv)38yo1CcMm1ZDFj$>-LOo)_i60x|Rg&-K9HsS4Qp zx#F-f$lw~0#Rqp~D-C z2zQ0?zWvKmd9VzX*42v?pL#Qc1tD9DDQn_J`NWZm2aoGnxpN^3sqEEnND0KZc}XJQ zCdMPKh%esl2Q^#a)nwN>C%I*}NxXD3SbO!=HL_|bnuF4s&DxzKQQy6d^|MS_<8)f- z56!Of(IHc6+xBW>xd(#AI zp`h>Agr=!fXeeV(B}s_i{+N0+_XM0Cw?-VCQci~^ocixlNGD)2Q}&Of8NAPtR)Y)p z;(dLZjuwybVg&ZHHkDQjdhxpP%fMH07Fu&38J%Aa39r2|AL`$vmGKmn4g1}Y0B$~m_m#AK zx{amPR#r;Y9b4%q@1}w1-`HN9E+gph(4_o=J3el8z;CGoBj96r6sjo;EQPMmL=5 zO@IQ8ox|EoxEfei)@n&c;KQF=o?2rHZCACKKmD7~LeaTR*nQyNZp*oiBnz1HJ%ITZx;p%b|J4q2=8$)F@?Hup5W_)2o;FX?rX4 zG7?x(z(lTrv&0-tM>RWO^U{7tQZ~UdYo*s06AoXf}F2zxJ{L6|9%g5QI1C zJXbh5)Vba4aw*t9MN?V(3AK$Gb>%Hc3dZe)DN)TB+XYcG+w7J@lFqylXBAxYcue!_HXhY=_$7sEA2^O| z41ch;Hue-#v*2;(z{LyTyuU!cmB6y*N6h^C9thn{ul;*@>fTigd-B;+VB|{A#HqJ!G0re1+89L*X5C zv0J^v*RXev>}3n1ce+%fiySGp~(F(#eVH& zV@r70SL3&(8&p(nO6kjIwxfoNa}-Ic4%hG+*zqoIwyk1_Ad@obYufNE)K-ly%oo;P z6y1tgwJSNBM&qoSIvUY^S<|EadgGRwso2P|@@@m2r})g4p$R;?xPpPfFYIU_S|0CH zdXgQ<`)|7ZA@A^MU2x{88Y>&u2goxDqO@+mabr6Mg!rPTQTo^|ij7bC*4N>)IeQ$$ z5L|q>I-vLwy!g~Nn!uzMw7D=T!BL;rM|I7#;~ydMIW@$@rwk9@<=P{2uZX3zJWQVc zv|~4?IMuSzPglE%*kQ%*t&5qGOoZRWXoRK;ltXo;DlCgZ&1M_CBIt|Zn3->zVLqUA z;oMW&_{R)*z|(V=g*2~I$)>{F2hqJZWQAwU*B&1QE5*sktZN53f12%xG!GDAlSo4P z7I^@nWrCjM|anc4KdLeb5F41X_D{rOb#Qm^)W+6M)_*|0XWdL3gl?$ z6$*zkn%e$%>`XjJ>r5*po9 z`&wXqC_CgS;o!u?e)HOd=b`grgPdTfGW(43=G!0k?l8eOdD|uEmo;h_sm69Q{mdm) zUUE~#I*c&76z^rxvl;fwQDwj(Oni0(;xAh1`a8LBwmB+!9%7~YNc|DuQ)3=^`GVh~W@j-7?< zG}a%~wZ>!1l=+1RnavkC*jv+n$_*}5Z5|UdaIG8@M-w_a(%+_-vkzTUs5v0AP^ zSkScc(_R1%-{5I3kgiM@8OZ4H{oIR@g4Le=QIGXHVPfsdqixSxnHMjEU9vW^;(?XVuj)vD@2cT0?%@(t?;Szy0Dl z8h1Tzm8`<9Z-Q(o$_D38l{>s-@!(e|tV?FZS?lJXZnNsrXXPrbR<-7u9D@Yu#C&pG zJoN)4>Ad70cE?Le{fn{1UC`6SWPYG^SNfOa{l*Cu>WUk{3i*F@eRWin-M_CQ5&}}f zfJg|E0z)GWQX&jUH%Li~lngE1T>`=&DV+}84bt5mLl52Dhxh&6yUsnw^A~HuTFf*1 z`R;FgVs8?ZkjrzihDuC38Q(YuB;_%S;U^R@>?|DaHV;F zZ%f3n7BE)!bd-06_*_bnFltnh=&BqkU2g6!MOnHvQ~5rXe=+C9T=C zvCbPOy59}?$;W$hHRdUWW-88ff6}R=!?6OKJLJNvfE}lyH}V9wp(P?tCKyg3^j5M> z7Mb@gQ5<(J7*gor4mZeJFhLZ{hbo3S+F8D(mhvN*^)aHB2E$boT?UHL>M?zB z2uf!mn;4z}V+UI`W4U}Gd<-KLrjQBQxRV&$){)0)lYeH?qn@tn$sE;d@q~y)ibmfh z8g8wnz@ulyF$wj1ZI&~C^D1IN;kg1gYpz1^Q}@`XI}4W93PU@S+w9Npnv($(jA$!b z@RXeEN5kDGLEVuumK6O4j=mH=KVi}fyL66h%0v#+?AO|}Z)s8mx1}t%MYJ0;a6sUi zQynhHn*ex8C4T{|+HNDxYrez%AZbT-^<^ToIiX^v=9spMn^M@}Tf_Axxz-y~x;%;K z@PT*PZ@fGl_HN#|pWa$lEbXfrrw3&*So43)Sz2!XV2yA)3A1kd%)n<3G@-9#2w`jl z4xU!Om>;F6u3&*&aG`o0GM3Znj@0#1sgMC3jf@8QuVfHHSY*9D?3N%ol$3Mmu__qN z`T6C6P}GC=?1tY6Dl-+3(FVnm#d8pd{&L^?a;!Wf)S6XPSC^wZ?e%s&u^PHqYex_(H6;8&6BTbj}btn2v#Zt{x-A5G9Ld~~D$WqN(M=SH(bzNDLvQ0}$jQ)&E^9ZX_ zgx@+3N^riTOk^uZ+S|2oF*=?Vm4Hq!#)3Z}e0vo($g=k{-9erC^ zp?>ApSaxMPCKhZ`CL$I+tt!D!sv>?S$8Hw{epqbL1v)i>*`A!?T9~P6flNU7lkDQ_ zq20L7iY4d{h1LiiJ`-|LAS)&OgRd&#+LmVJd^N{)I;Y+yd@7>o*E2>iRLB^QT8Ern zS@z4XY5JMW1vLg0?K&S3MS}Ik_3wOzp}U$)dNs^rmToxieCyT*vFt~NF=D-oi6Ky= z?r$r02)_P~O?AfWIDCJSj{(M(`*MyeKLgJX?J~{}IaX>hhd(MWU)yz*-G=r)=guf3 zn;2R@v82|7-UU{pbees84bZi`f$42<`26?lTD=^MDlauMW=s;H z)wKf;rfXg4arWF3c8+SVo~EsZcxGitKlLe);|CUY++#sxQ}WXAkM{7S*EU^JGHTId zKU4XO9?(#dNP-MOSh2N?(Y%{j6sI9vx~||UN)3qpO%l@ zA$YcP+@Q1~)>X}fGaqkJvg&?%Z%dYH&<$1&gE@jxs-q=LN&#W$Wh;@ zx4Re^Deu2BLEgd<-0KlmQ+9(PKKnTUhWkE)4?6<-06um!tWdmhU!PJTddW}y$#D(# zllMb#*+}T$!6H1Atu7kCEj7EhpJN`P${i{BLSyN3`5K$>JazL0qQ6uvpFQR}Y^P^f zaDKeGxg;KSZJo?3(Qm6%uzG4+C^Q z*4ICaSP<)+Gn|E%PZg~ZsqEG_rmcir5O+(<0m+eLY~rt>Q@bR=zrH1_Mv!zAp^EuDvcgnF1v26Ia7SeApM#T`AMNppQqI&<}BQcu*q zxkrG*EJ6+PdqDa!c>w4?DOjI2LP_10opw6dps~679DYObvl@R;yLuy_R&BL zFD%sDV7Z-6JX5SMC@%m^0~Lc&d^ja&!SD&dyIuq7u_x#|7YcUvhVtH&nhEzMvTF|O zm9FyI#3NtmcP^u%#uH8){<|u7s{xzA8cu? zS@))S#$b#xWX8s%xEXFLTZr~WLvhvZq4=!9*_JHpP-2^~0u z4Q9-XOCMd|BQ)wsyp~BMjmep&ovFG4xmN8=Wx^UqoG|fcHmBX_n=b5`bN^I&3+bD1dbq-iPWg zP~}M(N1!JQ%oWqJ;0dMW#O7?DCfYyHcm15LuoipMiN?DwR?Tv|#42>F*o{0J#{mXb zQqd+Zu*~wyTiL#gwH!puX3&)Y{e`ms79*i>RME{zl8&q+nI3JYm-?%=2d(8{yi*4% zYYs+oYlw9UN#!%FnwzDZ)Bb znOk8yWV+ejTsbGfs)lYk`9E3Rd-L~RbrYRWdT#Q7P7UgX!%^aH;y8D}x9mMq!U^kc z|D3#yeQn3Nd;I#Tw(nFpsR-D^qk9YmNVQD#{(!cf23q)e{P9(+2hF!23Q!QZ~ zlx76bh$*eK%YLt84Zr6Ox&~f_a@;p7?+pF#KJ5QXMg&_e*qv?%7786as-(ScCPNhi z*@kEEHg^$P=c!$BTyO+~--s#ym#}5gs>~4sM?|x3Xry|J?crvxZ)AxsQ7hqog#Mzd zLoHc{hG@7r9(QSisR?0C7+ zc!VC2gU0!%bh#kckE@GfUcM88(&qZ|Wz0TST~nCQN!vmdYI*QPf%#4!vs4g=G4yGA z>OBDfVCNAkwR%R82>@@=@*vcBL?OZL7i`{zMgmixA2-KX* zLEMLspw%SH7uDz6%I{UG;4?P*2&{BEDCBR*OjgtBFFs)&4>OI*XuLC z#LuMLm11X1aNOEe!KqVa8+hQ2>a`Q=<=5}!m%5|4wZC3SQiv6)@W0ZdUXcjJDNt0J zC!Gvx-nPi=xr{gfZe{1*=l8H7z3a{5RdD*e(oW|S9$(`h^hoN7TO2<#1=Hg5%;-X) zwtyx|rNk$3eoI?Nuh<16b12?_q2SWBR~EQH*#X;ZiNuzl)TSFPx8HA{qPsM8NU;q> z{L&%K{cU4u1EH+sb@xE;ZN01S5(6hB@gO(0U7w;6;zo^|$`_a^qCuhsTwFoJlF6Dh zXnO3~SA)|YVn*l!*LRA1AA9Xa*TZ!^xMVoO8EFgfNC3jrq_@g(9@>isy4V#O>i*`I z{FHh@!08#YQs{xn!)~Bj{|O@O%tGRA6#1SDpO0jf@MCD*SMAO74-;RGT6{F4ma{PS zzJswhS;}=T%>iT_vd@pphc`v3FT?g}X~^%HMDb74e1@NQw&BU{kuGIk4wta|!P}H@ zBFo31!)Ld_e5F0!w6?L<_<`<7ow4OeY{K+W@9$;4B9q#FnMqB!ncgcNJi+cSxXlTI zRm%F*@zHtJAU%#XU$MbtD`=iw4SV(>P@E@`rpdiSsg@J~e{oq_6W~J}z1LtK^YZrz zt(WZ89Y3kg3PYDpnrrG8AfyX?gA0xTy z?WY`Mkfuokasw4&>v(gVbkpT0`gnpj?)k=S_pMkf{|-s{NmPi!>h`)A2%=1xd-{dT zV4Y<}WCCE40bul&=RhDf0DT#)=`p^5+efDeBxRjgUt7|p<_KNSca&^F@<;QQ8Ws=L zUox9&vc`W{l=?NSh0mEeEXln#Ap2a05r_2Lt1NlEFiM|NvGTJ|cHR^6$x3xWxzDlj z%&V$}wm}*mF(Knc@-Najm749n9mjsNTE7~fq(%MI7qc(eqCaVTAAvx;#c9-9_|3jV z>7d$=ex~iplhoZUE=p0ya7)+l zseA`=){zYY0MQE5*6CNZA=$D|Np^YyKi14cg^Kuj$R*~s9JhN#Tfg+SO%HH;(m|n* z6S365`UF$a!|eeqA_Y&qKj8^mTW=rYMLzE>nEtvaiSBElP>nzzQXm&{WU1d4Ty1ij z(Q1oeQe8)(jSoFBN{Uha`5b5sT>Nc)0_M42-(jdIj44EP#zH@RL45p0T)AO8T93WyrbNl7(Vfq%zSi)wuah8R)KfyWzs3?Vxs*ly-uVXE zf5aoGD)gVUR((bzDKMQ8HehD{n2~bVof8PI0_-B&)g&yrs;X2{hwB=s82O@$M|E%o z(<0iFUq-I|ZyQ+s#w?Su#X4Z&Ajdu)7$VhN*FF$IO1L|93C2!MGq(g|_x&^cunI>N zC!_0fDJo1zS5a)Q4$lEdFF>+|lWS;CIUR&JtPYATIY-5A-XZ>b;A_WKz{eq(fMQK(+pBgIPaWQ5X-rS<+%QkuXg71>38LOiv(EH`Wj z`|7$@h1PLTxX0ND(8B|C5M7;d$w*%lXd&l(rPJK+OQmE9xq6FIZWLHZO!x9>EX7Oo z_NRO$(+$)VTX9OtYLjs z0R#gYjT1F}J; zXbDfzNGm;Nz2|vvPIMX}XHE&&X_iR|I@Vi<1MS!8E8@DZwaNg>9#_pZr_|9-Z1vKhz!p?KF|sn1E!a1yO&gavsT}jQE!uqXQUijxId&3+`%oAKx=IFT#W7%aieww^GHOK}A-PmiLWUm6;Fg*CH>ZQP)ihb-VSh%@ zDEEv7Hh;axUJ7#fd$oNhPcFt&{w_6jlkOSBgNhHxqb;Fm8+}S z+vg#*I*QH}(&=P1nsj^uc98cNQcjj6m zH4devUcHLa0)S1o%Srhmm^nn>s%5%E@q2aC$saub1a$v8W|7V1N7h_2XFrH4JT&Tg zmdu}fik-9fnGVe__y_{;4Xh>TQvqUu_^I1`B{Um<$V-p45JWg(uQf+++ zN7geKP7*xw2FK|fX;_&VD{pZ8ht`!OiIIhVM4=WV6Fmjpg{NK(%ttm+B#%;2s2APh z=7oQb`|{gbM&RiF;V>3;nRVzCpglUr>dk?m^&6pHV`Rehu4ZsA1^(R3orIEB?53>& zpOxlz(F=T#p9t@;2tx#27JThh#e zJ9T>3FYa~Ld4WzLPoYlDJ62dzbogJNk+ohbG{PvA{KvE9BA2`ul%!sF&r!(63xb&? z!~LwX**|5tvv%l{2wQV}p`clmUewwA4GW-ZY@J=u9r!Lb9hNO;Q3=AanJ;5(H~lVr zcu2JCT;RwXUKXG~Ou%xalZyWlmE@t+xBvOWYgAO!O4jzXpx_hGYesko3-yWxDt?95 zu8ZOJ*p07HVulQ8B3ByyY(E0kA4{vUZt_Xt`xAbZyq(7!sTe4`=gJiv=i8mjPIx*> zAqo;;{~Q?$7E8tRta!J)dJT$FmM@jkshQh0*5C z))e4#fA+ACUjDtMD;AbC_kGo6re6q?@MA^p?p%HQxMzDtAzdYo#K#ov{Vlr6g)w|K z03uCRn($tX)^bZ&@?$F7WpS0F4k3jImZ<) zIuj4d+$}M&I`U;1SkPN%)-?GtG)j?7C&amg*rI9F*>alXlO0pYHR5uA79RjCl<(Sv z%0MPz_F>iM?K3KVn~W3!=WOIhi+tsM50%1G6OOC#+P#=kc{vlu2{P_luO5|O>AmlV zEK{zI6CMu5%)BE>dG|T_7v*jhgcUXfH;rM(0GC<~bjWITV{w2a1bAL*;}z(VeD8Sw zU6`Z$<1*)eS;@I9P>oxH{C5W#>DOJ{>aJpDX`%OvDu$3&-m63LGiy3<%02sLaNL$} zv`R;v*TA9>C(~_Ia0Mo=^Pi3%UtmL#XCZ9naN3_;8sNB1y&TJ#u1jy1RlI#GS>c@P zY`az_>D&0axVC+=KnBgo&ptLv?;IOzz*Dz@t!lC(iUlmEEw(+mj;WmryRCi>tdf8_ z^wL%au`qP3`2Hw*9MP#o@4e|}VPyCmH@8pP#T-1&kFT<4)@f~b5egSdejx@8GI8b6 z8-A|`gv*~vY;Q*m?3Uvw8UNT-&H}ev7serJMlnJ+*lWSoO<&3lGmp+ZA#IV#!}KL? zvnhXdeFe|khHt`m2Q1a)nU$$51KN9cBh_rsSKvj1>_3TFiXYoza4}~I%w7h5%9)Q) zZa{gAxU%UWJpJL}xJhG|`zVxjj?z`junsz}z-2y*epu&FjrFU1Qi)rAuWnh^iLNGX ztNrkDFrX$iXx2Sxac}mvApm0r8*&bP#gcj#!#r|?+%RjA-XC1Y@$6l|#c_|5sz0o7 z5O4R}as=nNQaqQNoL=u`w;3rGaR>JUK$Bcms%5sk)7}tUK-hEIxIAUpVV~>akI<>6|ORk%#y|+Vxqvk zZk(`BI&y9;yIVEmyC$$-9i<8!aHSN!wbwmy^x(Pi-(c11s&EY{2T?27$y1geoZ>{k zUl2*{)EjGKXaB^Laxi`fo4M?g81Z*(`TXco`0Y%0V)=EQt7kG>E3_{EipK7#pX+Uo zp+l`?c}g#Ozz8w3!xpR3gov_8XX9~*BLl{{iaXj%#{#{Uln)&@2qV(Wg)Yc zdwx{GZ;`WnnyR4;0E+eYEvrK|~Po%f3w9a^&t891scH4ZU3@(r7@Hqx*A)1g z3Q$Mn)~FUUw;~#DU6%nFMO<(Kv-l*9R#u3Go)j3@`2z_)(@@GB#WV0eXFGv66j`DV z)0&_6>j;Ju-(3=_{?dWWikAPf=*YOwLY$;`Rx@&~muKnjwN8pDmylo5ji$gUPArJY zp^P$Ax+t=luf*UO{oyVUERA3zA!b6?E$It8vU+KM%$IvqgStZez!x;>uf8A(#%a)p zJ2@>pY&kCtK|8ZhXqQdM0tk@IwPjl3M-1-(YM)^a9LlSYkxvs!{tlo%#tVOXFF($& zYx3xW$(l@cOu#eQZJx$#oCEJtMtGD_rvO!Vdefq?Ve**J5z?&&$a&y9e4FiJ?zuYc zdBbd#&|52h+VO&!t;FdkcDfV5CNb_6cLmS`auIybAD51nuRHC`ZS4=UXPu7}kxC|h zKbdmQ>{fMn6@JO-rUFxg?%hx};cXc(cnfn3IV@pb)(E$pl-Lt*B}LQn6i_-e{*dfAplQ+G&#vHjG{@EZ#l)MPPstA}K^Jxy%l3J)h2GBgJE z-2Fx&B|A3W>?jP%4jG_YQJYAGB*@tZhJa|(i-fcrXD$Izo7uqe3&YlSUq`!j3fkH| zGqPkl9dE-zOF)IB;;c(KwQd=MEp{&V`b_)&uh9zXJe%BP!0xyrK>j3M!k~Z}qFT?? zrGA23Xf=pP60W?k4;`vt<3?FmPf!r~i7j_JG;Itp%Ogrfki* z_hJBY>21fOV`cAUJ%0jxaq{(fFDF*z_iES?RaI{+=o&g)bq6@Gd>&$>FSrX!p}qnz zF~0!mx4|(1fcax+NgUm8LTZ^Rt?KED)O8TlJhZ8LV$!R}-c%kRS5Dh({*SqXUUSRv z+f>n++q*hVWdyA7U#8$rNfY@t7&U>?&F^kEfl{)Tew82|U{p#839IQygX5UQp_*rR zV?`4h!#Z3}#JeCdMuWJvM+67G`fSL<6cOTq3_cP0_{lZtvR$Tx@ufC0f9<@O7=OjrjO(}P{&bOrdQ}XrqvLE-VU>KkCw7QXrh+17q zO~K_rJY=}m@~&a7LWZQM(q>-N*;hK^Js`VokhzcQpnsxTEHwyFyIR@fn$-aA2#4N#^c*O6l`$S_^wjOpyjsw-N1JI5LVID43nC&b3Wx6QU_ zw1u){0cDg%I3@tjXTBlDYUK%+bFk(ItR>p1xh(sRb5*~GDv+2pfCa=7_r$8k*KO{_ z^77*ox!uIeIc{9g*ATzx_yi8dpcb9I(v z(r_oz_Ru1sIMW*S-0KQAU-V@lr$)bi%pZKNv1Mdb%j&-Bn#G9wn%t^86Ab6KklVfl z^BsNu?ivuLP`e6GqQ+H>T9H(lBr?Q_dQaOMo1i#3CJ!KURv$FGg_p%%V9t|vhQGjk z@y=?y!!Zh8`Gj}Zj))Kiw)A=#;DIF%qg}ldP@(1Lcd!YLZK5m z%v1d?*=aX`{D9V=wcV6N$K&P#J<3$FJ0S3vGnLLx}HDyXc1a145*dmy+u`8Bo*0G@s$kE`E^uM5x-h# z@AY;G?*@3@4zOlYoyc9+7HzNEkJ+wm8;hox>qo>1yuzkD;T94+=Fa;-YtWsTj*eTb z?{Upq7AmLPsR$%lH|6^zd!zAU#E_D93w_{+Nz8;Vso)!V7{81*FYO;6=$q*>1C}*` z;qNcwg+kGIz;nR1%_9%DQw_*<`*k3#!bYOISmkwGr+YWPqmApaPWTmhls zS4T!Gp&0DEFbOEyrc;7jaM7OGwi5`(@3N)!{*P?%SFTPrcT`<|xAU~BfZZ5~HU4}) zQ*}oa6R2+pK*Q>&tT#KX?aXRA3X6me5W`s#{QHUGIvh#UoF}f#mkMVu3|rd$eg`Qe z%o-dS&81owFi<$U8z&d5)|Yga*eg(z3v%w)+{YJ1{8?-sXxl^GttI0Tr3`P8HcMR_ zXK+MHyGs0t*)Zlv-8R7I0TJa3L=;F(U**Q$xnSmiNsC#Si3Ynx319r^)Ri)F=VN6h z06UxiX+46m_zi((bRvH^^Nyc|%kebpItOw;{8ERBJ2p9osz%=C$)Hn_$vfj5-p{6) z_K|9k78+vQouvB7K=a}B8Qs2U+l9hNW7HI2FNp_d&VQ$vcX=aXyIghfrfa9M;0C7{ zwb9g@38NuNZz0M5cu(|7qPF^IH71pcNuNA|0#aku)(%KvB$b^czK}DMd&@G;KG4UL zwT?X9pQBkzq4w_CyFG)wQiUAmdXKa(CJWoXz#;Ze$--J6qzqXXFmK66GF_+UN8P2amo#;3IZY}@o? zdX)yofvlrnlzo#byMDXcs`^e9Muque!>ufTemu6|C;c+_kFmtJlqn-HUpX`uUHfM` zZ6-)*+-gd3EJ@DY_dUP6ZJ#5ZFcD$ReQ(Rtp>vcdTTG;In~|R?PjAJ+aM`3x`y<~q zu4aA0Il(PYkE@f)ZF+NRomRVEV*_Bpj{lTE3SO{PV3?64)?tTpyOgo+zH6d-j+y={I~4)H5+(@tgHnP zw>-GqQC-j3z~ikN#HPi-=zdzxN;{9*Gu#^Cvc8GD)LpZc5w5eU%W;AJu{ulFRCLd5 zkF!GxYs#NRPq$YG<>VV(XH+-N*))%arG{7XHM)-w8M)A$dA&PI9gAV&@+J7__Z{X)_X7$lLY+sY zKTN7MEV3G&zP^2~Gv-a<>5-}NR8?9xT6#p#OHNx4F9nyAr}fmD`lp+S74$M#%ELdU zTvU|)QBg9RK#5H;$pTsC2I^%A;5cD$?f+pnFCnB|2BbX1aXa?}U}$pNT*o7W%uG7; z39;6z30_1Lxd6e`owk|0r^>WYe8hU8Qg0S6b{^_KU(IB>O*3-ddhK7Oq_G!Ns#Iw( zf^pSNDovF>f(gL3htzVU@^ULY7!Y!pSqIN&$nN7I+PN3$Z5)8)1NTJk-_T>wlau~W z;C=o70?(Iw69Fv^BN}BtiL!2x5>hWin&)kAX;0MUXIO4I*-V*TVK_Q!&65fxdI12Sg${2M@%kMuJr>2l)+3pf+vF z9F$(_A6Z;qYA&pD&qbygee$-2 zT4vU+WLC@;WiuFV&uz6{j&tr$5m}KfP`SCxC~dG77!EcSCQvjh zEV(k%XW0Z(|3u$;3%@#BGtQno;rfzu49`FN^h`*uSY&2E#@=i4aklP+Fqh4>3JCG8 zLAK$Y*g_CQ#9fl`#$inS1xc3aLO2=ZyKkh<2>~}j2IYOga&`~ajghM$(zQ6?*n)&W z>54Q?rU#%c2VpfMLc7V!t}Ig?K?sQ-r`QtJ|2+#JrCjd#%bfpIfDLwrE2YO@kXH5~1wB1NgH&oK9d6deMnktE$P%fwr7n@;k>losVS6 zMW=EaS2HKKJYht!r6*D5K&U2Tcj30?Tu}+`RYd7YX4V^~inF>hBa*p2!TQ6%| z%GXKz$?&AGA(SHdWY1V1-CFHVojU;x!`7wPP{mp7AXR6o^00rpX^|z=Sk8w3b=woZK+^h5byw>gto-J~{ux6$V$<*0=b&NMFlIc*#PE z(`Kpb9ev|@()$*lpU~W+HC9UT%dcESA>EEp$VbNB=0{h*k0S%f=JAn_J7IWVXl-s$ zDx4EN<)p$kNcTJ748>!wgNTaLO zodz#8>y@M_@YvcC;ytu?xk>b>_?JgvPQA^{4|qdK?jlGn`1bwa(T!^lx|L`B=;dzo z!`{)dC&etNg-@dY!E0p&emm+-Nb7kRI;Z~N>+J}@muanp60m_;&_dgZt2^g4*=iCnka8JnX6LiL{b&kbkhsoG>mHYe zBLj5j4;0aQ6>b=(ZC8tJF0JpoepssIY~JC}po-&{ z|8s=aMj+dEl_jI!ry{3kE1cDRXp9duu^5Db>o(__#4^y44@~X%v2>5z1g+K6#5O;Y zRXteFK#93bEL=F|CuKj4WD{-@!YX}HBFRE8B^vM`UR+dRF`fI?XTnj^(1oSIV|ptW zy)w*FoqlOd4J@-{4{fFsCxPEDCV=dA7sluTR!%!9<%Kcn((wc{=uyJj?Ger4!WDVP zB62~znI+0{wuVtcotkggFHt;tM9(4G7Eyvxbs4y^UDB1k;KG^`_}dszp%+}3x_m`# znH7-u7{u(eYaFxQ(mn$Jvl=^zpSF6jCb>8)$aT>hfl<``gXAG0N?iUJaqS3mtgOH9 zN=dH9pQ3;<1=so!4muQ+xr>cDaJv{hQ+I;a>Gs-`|{2`0_c7NE8HBoBjx8$>vKbi#a zbfJm5Ouy68TI_LtL^O+ny0F^BustOat6KE?gjy=K55DQj4a0s87jb=S`bC1yghM53 zv`i%JxI5~pubomEEWRlIg(4beMd{{%er(*7>iaB6KkT@7RE5n%oQbsWHpRP*R$l-A zF@MUSMQ%UpRV(MHw~SB%2xS&3SvTTLD}kG!c69ayC%okV#fJjLe9mRU-ENx^%n28? z0d!?EU-xAELgIq6pCp+4Poj#dj~dTKTkD-l1=PGp|JRo!B6;?By>pdoDSIpE$;t7? zJ{IB#cj48J_73F!|J`jl+g-YEslz&+#k18F=)eOHoYou*qYn&wWtF~z|6=huxWn`M zfQDOj>9ofwTGhCb6>2y$jFqRBFo@&+E1&y2;}gK4zy~-K1S*_c7s~p@fwKbuhXO?4 zZc6GbRaYXc2w#uJkZkl`JcG5-AG`KGK3A07RY>YU>l`@)UgHKRb8@K^o$8~Y zZ=aIQW`9kX-%CBCQORH$bYHY58dTPn`F({v8=tw|gXU2XP-lj8_y>Fg=-b2nLaW|# z%z#4JKZrKChy^~_C(22ukS4Pt9I0w`W4fIIoUkygJ4gAm45Sj}euL;rSo7H85soz7 z(q2tGrsca#Z2W+~bvrpir4X`l^DK(2aY?e=Y~IRZIz6t$utr7<^-pgEa`ef^hc6QiBs%Wu4B*-}Qn9asYw3v{}wcjH72^+PITrhNg1E zdqdHZwW-yb<)q|IiEG=fiNZoIvpC`oy10MV6+kzKQd0zed7jN6$~q=KR7wX7XXx6{ z&K1$+vAlq|yY6f%W;9d*g#UtPgXu;imz$_f&6dA*3=|A(Ja1NO2kv@6i$C0jJ_{PS zlZj^gXN_U7N{#E!Be?-wXoks~|DxPpkECSdEP}HH`7cyFxH=)*;~$!-+jHI4EDU>> zvdS!0EVYNf^9D$Y`}cDEPnR0r6R!{Kg7Pq7S|Pq=g|?XKOZvc48jJt{{v*6vpqX_gZIf{MI{lKv#+wV|VI!mN!wASfF0C>^EG6vj1BCFG)3% z3+0q|A@;MbxaU32l&{TO1WKgBcdtN<(t7`arK*AU8q|+0P;9flGR%v$#F0OkRlS=iZn$G&vCBr@-_CL;z zsc=+&yO4gvLN>0{aP)*9QFE!51C~$kW+-t#LenJkZ!j|CQe4}E#!WEyOW-@Zs1<@G-fQ$*?` zf(Ci<#Q4$q&;LPziUh5Gy-ZK#V=n!Br$GH@Ej>cl5N9~3@t<9ZfY+?Qw` ze84|>voA8gj99M=)Sy5eAkG|+Zj|}YSe@~Y5_W)=>Hxao*BlFhhW4ZhN)J)Zw*>!Iu`OPbZGy_%l|mVSS0`STQ;kI^Qb&`-~pl;AE)Wt5faDUn8bE z_sT!4F#n}a8U~1#2@3LD*9QZ1`>V!zG!ygPEh3d%Er{lIG#X?rq@?n5m@HY>8ZE7a zT-aO5kddS~&n^?9K=cnAhjez;@8|p>G^!<>GV6ad5f$eF50V437I|AX&u2?E<9uDGRUJap}kh{=WIq*jQNh?MAr z{mnj`>-Fv60ApXT!KIx5;f@^LhAk5E;Osc&*eApTv!r5*5R(tc~HHK39G} z7GExbZ`&|kF8dTD<$T?a3nxie+mIOq0X8C(5M2rqIo`SP#POg69%e?-l-BgyvzU&d zrUWU)Yvf9WAp&K(+%ljbMpU_u?fLnOi($O2VJAH9&-2kwgA?qaTy=+|t<>^ejiy^U zyR879&Da>YGUU`1;vmtM(j>d{gLI+$pJ~PXep>k)O|DxP&12(;u3GaeJM`#5lD@|= zyi0zNQ2Q?N5@Q~RvH=N*5f5T~3+?PT`lO8{(`MXVzq%wt?DqC%MvR9+cmO^c?Jo$@ znje=$Yv@aS9TCc_sJJ7F>h21R*rx9pbyedCJZ9L$WyrywF9@c;Bj*xYJ`VZ-Gje>k z!gVO1=qr3qudSCExv`2>>dx+c((>BkbhLQ&O>l&CU9|5lydoX03?tA>Bca<3kFy+P*AU44zgR%*^~A$(MHf{xoXY0LB92B12$I?UQ?s!u5K zMd!+D_~kS{8a!SkkB8{27=s_AU<4*ntY9@+qNFnN-vS4={3zLZna}ohXDV*=+-OT= zu>1sH(B?2i6o#R*b@IFv=_RPVP;=Za$vb`lSk0{ySIfs_K2uz#S7E$)veFsZKprF8 zuSMxDyc)-T{4PO_gR0;+o9W*w91SXmr0`Bh;72@;9Qjm&hwli<1dQuBDPwRc-=xv{ z6klBRw-p?K-h6%4OxWfr)V2SJI#t?5o^AM}fU0iU8lorPa`Tb02+5U#3LJPwp|87> zMM)TLT&IQN`Y6138Q#F-K}gohRi7lP>oYI)q|yW&6!25kS$|HuC~p+mp2d&OF4XeL z*XsKENgU;f%fU~yh7HP9y+_QXRQIg!hoBeS zW{QOKTPeA9a`+sk7g1@}E}(WD&KwYqJU#+3y#+KhQmNon5dk}L!077cMckJn36vO? zEt51%%81PNqffnM0H2g2Uw_qWZP*CoO102Yg6X+$;on!pKb1EV2V2{@Q;=N-eJ}3{ zlU6Mk*GbW87ONxey)-Gns9AlunnkY7J5r@sJd`IwEd4HV>!;{cu<9@Ovw)ZbOsz`C zdRU%HG0oS3H=_FC&dJ36iTFRe>Ho6pfOQsik)qNi5sd$HC&T=@I*|fuch3@g0W5Ja zafl@l%yPu1>N>83DR|m*r?r(VCVygs-X|2|{S2_y3&7o!RG%C4KLjxoRENj380KQf zx7Q)9L~7D3a4hB;wA&VkvW;-Hep}%~@Kaw_&N}19Ri_1KrUZUlmp-XE$z9vkHQ%WP z%T6(=6iET@gPb{mJD`f4`Stj`e1J(op3HjlQo37eOvecNmMG4v~bIqmp8iLZHym~~W0 zRk&_E6}gaT#3i2udm2>-zbEDR6biN8xjmzF+3*vKWs#P*@Hny_{kf4bde<={%E}LAJq&2Y#vmsXz&W0B!CR8OTd8o%xK- zq^(>xa@f^l@{isoyiMQ!)>i;_}X6OsutrDu_$VdcgKK5mT=LYGmCk-KYpm>^$4ogt)j5D9j*~v?zqBl z0k}=7RnSbHVC=`bU0`hmA94SEk*Vfhei=V`3CLx#=z+0??pc7*Jc*Rk2~>quw;OQ5 z$e4D*`=Zs3)SNy5r!ko?r0NcfdZoNqv2b<;I=U-uC=t11MWya6uYwd{2PQxnSoN*?orz#$H{*L4zl&qvie#?Nn) zkz5B^iqZYS3!tw1bDETeNL=JFkup*ZZ+!nj*Nf{lnYpK5*X!sx9~zK$jjBWxbN=@t z^zR8Nh{s-Udg7JK-_X>TP=+c%Wmdr&8c^4rpDUf=ba|+)Z`GEq(%@p~IRb{(Fu(xTAQ;18viI z3=BZw7Ngb-mEpQn@bB$kivb|;e|dS1_#b_wx0d?~|3^Xo&uKBDOjMDqU(IEnJ_Suw z>!4Bm9uj?ltK9PW^+j7h>wJo$oJswJ{aSZ&ro5dqayVjr_7x?(PV$4A@^JS@rrrtC zzkaY+h3~h?thGk+UuD(_^T+)qVh(0~4X>)y^VDSb=DpLhYz=!S_UXd`7^5+It!%AJ zCdEZaJ`P+20a7NF)!OB9(|nLwZ0-j?3fEifq;rJp@$UH$$9}q2!qCaxwkU8WKw806 zS;*W6v=Nx0DN$xgU02UCAX8#e0C4F9b|X3$vrS8tGP%d4j{7e!O}FVv$M)Z8)n7Zw zbkO+}kvDYwFGZglb+{c~!T4CKccx|#yr7VtXn3VjcP(;#yv^l#%4LB1My_z$iEySV zHLbx3j;Gz*LHLyunT_2dYG>KGSApDDo$np3X?1UTa45`@BoMR3Qy0vCvZoL+>yDMe z@5rRccZW*`X0WsvQ0TmxkvM8Yt{k^!A}hZ1V^?$ba`P@oRes$R6Q|sw&JT!dp5cN0 zFCn}^;N?)7nbqwG+{8XtpKBI$ByONu|JmJTeHVGW(>0KV{}#Vn|5xDg=cfG>0k~p3 zvnFP*$l^oAV&w1R_5hprM(BsQJ2O7wue@@A3vWi|g=&2xLAqZ@1#UR@uHMX9k;rj3x9(mFsL*iAUVn+;ayg!=1WqMDMelw^iT$SW=Gup= z<>TvVzs5glN3T`ld$qm0(x%sF{vOVeYWVL!6cn=S1KAyYHb2o*Ux>}{*raJH(+w_P zhz#Y%&_7xVrhN{^t%mi3^@H|yP9qPjz5|}U7-2Hn`2R!RTerpaEnA}r5F}_If#49_ zAq01KNN|^s;O_1c9D+LpcL?qd!QI{6yYX)B;xxp3WE&^$swrOqmw}dG`HI@ZB3m>4~3cHCe zUyaAUAwnaXr*bwHvIzI5y8gmm#b*hWty2R%%rPG)F8xCDucOsktze(eF1&|RMBf36 z;?H+q2jjSqfBzxR90onA<@HfKgRZLhQ!mq&kRg(<3!2}6&Tpmvu>a&fVA%UhR4INh zoD5|9iRiBXq`TN;>RHJ9o*IA^>;SB2{x4V&F`aLyfXiWcT@xa;c&V4fVP6c|7A$@J zo^#!{YIiKJ2B^X}vs+>CTSe`n`^D_ZeMzD5TzMVPK=hrdP}twSz93XM;~HR6^^Col zP$?{VZt|`BB7e&0wpbGKyZAt%_P9E0`LK}N6P#%v_BcGw+Zyox!KJ}wU@9~*Lw7~3 zXwt>AS+DY~v0D&!?eV6(`|zp{9yHvoV|p`6m~Vus!=#?uaGSn< z_kwIdVTua#tIGChYLsf`hGQnPg#{K7^*dU%oL7juG=AYkJZ|K|d$$ugc60Hv$sd*a zWRnY*aukMmdxogLH1Vc~M->1}y?p9iMK;d;O`PlcL!fzkWDinjuZb&{*JDyG-}`SE zHZ#_s$^is_1eYV|JS*toG4uPl>cDyOllDiKp-Zm+a6j13_d`Yz&@&lb%yu|AJn+G( zzhxmt@R!h%a9Wsab-q+o^e+nOp&k1ED8iidCyN|SFy7ES!TB$0)!!&(fYl+r2$%Fw z;-fTRk3fg=-dm|kaZg61H)qapw}2f+r{{c<7ve0u_xPaGH4~4&62jm!iEH$Z*V1>1Lj70 zs?KDrv8TVVJonPm{|Asr!ax?yh(a{gMkMnLUp_@L>+?cpjpG2zvK0D#0<2ZMe;iDD zmKwsWFl_ns;cj=UZ;;^ObH{on<1!$biM}!$2P|H|;MsXnR)#0iKL>dc%(XTiYY>e+Ch0WN`EAwvj%2Mt}b|FU3iAF#b?qQxT>S zTyoj(WDkE0n*tb2s^DR+vM@rGLG90hj184d;d8!(+7?9~d0~ap;Kk=gtr`h9E^tEq z&H~`$%vf&E1)L{Q@;?~Nx^ugFWfXmd#h%e-%;8?B0-Oq;t#$>S#&4sX<-1Xt8bX@@ zgCQipiF;G{&f&hWJTCKu5F?E-?zj)gmX~3 zDfW)%C-1|b*4e&EGou@?u|GPRm9I|L=$XaG9$P#;|hKV(_$BEY;}Zktx5@ z%AmzMsj^Ju2aO{8?~m&}8yi;s9Tm3W9kxmlu{FU`o zkHT7xb$>*HE6z+)c=?ka0&XdrdEN0RyIcMHtD9FJndq5{zx>~rX#ZfY@LTe02W7Zn zKzXCQzmJWnal1SF87>E}!{ZV0w-rh99wr-=sNU&NNU81i2f!83XcbepkWCtPh1t#E zC4N3zN~OBMWFDxtI}q+#i=V5PR_sYg%(bD_N#fp!C1+^7rPurg7zHbnOSM)4gyL$T zS2BNy(Q7gUT_~~Fy<>`iIo@-tg=X!U_yv{x=QSR!@qyTj0G;nGH2%!d%Zu4OmXGf7 zH@`n+$v%QSH33`w8B3RUj)zm3LbUFV<<7%0;_9ST=rviVuE=O3e4g z3#^u0*Rl$$m-UjVP2o9{hjy>!kXA&-3@Lw}qwxPl3_@%n@;H3AA%%%kWCxae$^j0> z(8s!T<@Q{DzN=9eH>d5r%N^bL+6yHAUZ2F(0w_}(RqGdJ!lgGJFv0m8%hHaAdNgAf z_(O7j!5;JSOpWnh3%_H`Z^KbH(U1+g$ho@F;_a z`Z*u)c)YYe@Y6e2de3KsRFV3O`Bd)kpTvg3iVMvZc9I?D{)O;B&j`=l@IC)%#pmS8 zxAZ?yigoz^!g+QeiUtc(qocP(TWLPvfL$In?l)2|0AE1fH~pI?xjR4@p>h*q)GaPW zeD_mqSFK{nM{{)|urHE82r#F~f33oZ7Uz5e@$W%ClgC@Wl80$+CVnqEgfo&z1oIE! z^g}=%a(YMn--OdfZ^BJqH6)-auhOGPO>bF+9x)Z=&E}UhpxFlJ9lc`Opjx>&KvdA0 zvs-zwMz|WPlhESKw1w*uc?bYTc$h1$Ya)}?@Jv(e{5Qvsi9t7K&)gMdWqn`1qj~O4 zXKfeOMvGtI!Bh;B473GeZaCkwms^z+Kw3<;!=xQo44B&q$UOx)Jv~HiBil`z+E8>p zysXl1yWjs83Z=|s4q`J|^b6vj4m@?;ACR0vKtINkG2BF~VnNH8msqgd#;E%C`*Yjl zE3)suc3!=cJ0Ts*Z>GHaJeFFFXbso{&OYl5fWET#vr{W^?60Sn9~s7AH|(|qimPBt z15*x9&(O`3wWoMQc_Yo|64Z(|-L}%F>nn6ST-XHFN4iaKlH|*CaElq3+YVRC^r9=1 zOGb6E?K{~_v2$Q4VCl*K2LD6z`Sc(1EpnGuISW^2t93CVy;WOT&U&WcXw;xvbjx*$ zHlV8S+lgH~W85lgNdm)bQOnigqDhg>xy&{kUqxri%WuqYH~~MXA0f8UkrHo?-#Yq; z00HX2Hrs}!cB9>D(;ku%AIE1bKhe+eS%dW9vbTM(_lb@&0w)6Vu0siZ4Jp zJ_S4VH~{NFBgQ$o{Kuk3-!}q@$l>K*V=f6doG?BwV3#PP=XHzCHx7lrKZd9k0+K{XLVnVGhZU*0 zD!B{i?NHLC4P<*DR#~22&BwVztd=p4;X}v%1epYRh^d|@ZF`&{*HHIZ3(yh$))I&T zv6}rrb4k8tA_q1RL-N6Ix|BD%e+&?je%8INcoAP`rAbxwxqWK#OFvb@1qhcnjS_JT z6|TNZG-529_&~HEI)|5lIIf>|a!@vZT&fS~FDzL=ry#MNk z`d%DMz%>!78`#l+G(h1`+b{9A{Ka=414BmBuhk~?PX@Q6Vh{CgMtR$Xw{kYn=SiUZ z^2fxBMRhx$`PWD%X$efVE>aM1!GVp6=rsMwIdvJS28NJbvOjgdeT7N(ZJFfD>IYuWY9$`>Z3(&zs*%C0wNMWh# z&$~1r2rU}&LnpRX&2oW&wJvP%f5U6_UEkRYLx~>j@`Y~}@!?(XCr>7_8|V|~<2c(} zK)kpDhir>2P$svH3!;zc;<-5Da&L8+@q5o$IR_e8LRhLV{7wQbPXG(%Do)wUlleL+ zyoO4w@w0X)xnG@p^kXpqvJ370&b$6V^ZiUjG{3NYNtZgbLO-q@GP(0jJ3_$wNv^KV z32ayF@P)zED`cJzb}70zpn-6n@?8~G^yT&t)02(WU^janpzr4aUjIybeqZW*Tn^Oq z?kD(lN2^Y#5~TIHf~4zsRm7cZ0DM`Y+m=)uGLP5vZO}haB6YNNo4t*v&T3X=Mz@49 zoLqfS2`DxQSxFJVs$)a#Do6l46e;;Reh_{c{IQ5;JfB85{i7YwX9O?Vm#NTYu#U1RW4N_(+wT z?tyGoYYt(*1IpLcfuVra-}c3?vS9RV#t)xOw|47)I9*GR#i(U?NWy=#T)mesRxZOn!D@EtsNM#e zkBfHyB;e5Ga#amvg^t~x%9sH)*T~VOdlE(NnVC6HdYMIbc0Lx)(;u!qXr;A2FnqH&~ zM^I>GQLVApd=GOP-G_vb`a3*wY)rsKzCnr;in7`FP*iq-ec~qtRZhf}1CAkgoZRq$M?8s2)9P zR|0W?Lb~KS1I=VIi5~{B?13mVb$f@QvEz9mx;i`NaU1110%`~{y-jza5+z#7DndH41G+ywqt_(_lc%H z|N69Okl?(G<_9cD?Yq~Xj0Tdw zrqxit(7CF7S~*3jxU;8{_+dn>V9miXY;2o-{-%z7cQ*4?5I)VU@5bQOj2y`^1w-DT zN>)%*Z9YNcWnqMjt#sc~1>aR>F4$wPekN)yk^$dzt7#?;Va=2^e>itHR=*P0$lpj| z^7KUOv0$pBbz~Gcw$E&H>9|+KuJRGKco&vy%+~yy_^0AHV)#-mY$+W@V~i|Iu;vTF z8A0euVE0q1v<6nI{Re~ZOqe@1#w!T7x66DUaG>4FNen54ftUnIX8T=SVp>R$Z0_nw zX08YVNv5KKT%U*>F4qhfhu+z< zu^_Xbg^Wn%E*X8D!YcPB7|BSD+9SHVSlWQM)qqgc5x^YDj75nT%MBZjW~xcJC=g$9 zK}Pzc-IL4DJmmxLZXNg~Ws@^;MhYr66-Z@Ho#NO%;oX{aIA}e$M$AO)2>SUeC3xb? zbN9!7U)9ecudHSdYy2+Z95>$QC#TuGdK3Bh6jCPROY=Ma0X5!gZ)!7Rvne5cGFMJP z1ffO9`{^R=b(g9ayLVlac}b@40Xw+N_tei74V;QyK)`N#$Ll>*koVSOy~7U|Yrnry z@5)-)_K@F3-H+PfNoXwbpkhsp+{N0h zODDuJ)l=UKv0slCj#B+NG>qK5+AD*SOU=CnC(Gq^)|y)Q)nH@a3sFBu{iI6|FczZL z`b1omVLH$EPmm^u>|by%|9DU2N~J~)sus$gq|D`9?Tx;Q4|IGa4QkiCVQcJZ9XZA9 zCvEwom4%Tlf)NXX`!KSoN~P(zpB-Ryr1q2_IVX3&EQKN^mL=YbUTbO5A*g!p?%_6 zLY2p`7#yy*eB8q{W@p^k-uQ_~z+};0&(5RO$m16^U#6xL`U!`8SygAWNcq)zj`WHB-fRSDp_%VdVkzY~Yvp{Nm9R+mPHTTUWb2dTGzJm#Z2*I$0xMLI zcErh~1=(03FB!{2(KJ=3nFy9zZ58G)X=x6@BX9D$w?nta^Qt|=^>d`iExN$l5p~H= zSr0N$L$x#4^*7S}W+$wD51UTNXwY$AlBa0#M0zbDYA#$><2=vi zx~ZND_=)>lVlv6S3;zr@cSg8}Jurci*E1ik`IG$~t0v4wQhDW^@YL zJKXVEmD2m|a@|w;g{Y}4&uxEf)m+#X$|)aCE0+ji-B+qfKnDMy_-Dt5F_r*K~?X>Qn@MUkxcg%uQqTY!7}WF^iLoad7dH8?$e z)dWliMS#DLyHe68#!o{msoQY7C|R)l_0%!Hw7*oOk|83|2S zWV&s)8T=E6UC|O8D^OvFn9t-~!lXI>5)Htu1s<=EOSTTK-qB;up5^Zz%tp2hB6`W~ z=-;>YTHD7rA5P#i@s7@MmxayA6`;a3+s(TDvqJ%_Z=cpXujS0m&-N3uOcCw%*Q~mJ!kQSQb9vGVp{Sg-C3@W* z@PvkNWv;g#Y?Q;JPiSHfzGF~HXm^(@$84+LdC9mk$POfdnJr${a_zmiAHTED;>0zp z-BHN)_EKp*RL|tuG|q2|6w7}97B;4uD7#iu$BzjfnavCwy8qzVhy^2RfW&()(&jk@ zpC^B}!Vx=t{2G33QSfWj>ry%BQRrvoLldw%boLOmzGZ3pIF4>IGZr?D{)yj5-@>U( z&&xkijvy<8iC_M%f=;@O=Q_9ckt`Suw_0qk5%%<6mX%FLx6nlD9TBv8!Sm7yht1}U z%_Pp-N##j$;c^|FHvk{;i{0)3VEwTMK%&686fpiop~7ly&~KoaH@?n|w_~)A7}0IO zf49|n4$ZA%3E2TOF4UCg#-Ku3!8;Q@n!(jg9Ln_O6T+@Mp-6-lZwY^bqS#&NvXQYN zYBuU8>|F(71$4eUg2a-FzFTo^oOd939Y#Sc>=Nr9v zrUTvPXH{|L8>KX6-RmWKO*eu? zw5jB^mXhQpBDGx)c6855qD&Ea^er4=t|=KSS(AB7C!=bsVb@F~dT(>CLiY5w>~3Sy zSmUgocb}5Bi?yNAAThk2N%g$F0dYMWqOxrb=)t;10b}L_kW9+UQq})7cRsDYHCmVW zhC9pbzpjSNgVBM?u~t4EgpAXkp~*WJ@=8eH7C{k;2xHaak}~*5RnKDB0c7P`Upr!R z4^vTRIw-6Xbd$QW`+PwXu zTOK0}*-hj0j+@L^P$;@<{$zfg7DwTZW_Y*ocu>3UTq1y+Sc~uN>U@HU=sq=x?%p~Kdou&NwXZ04JZjU>w2qF}+}iS_$n7bGhIC$e ztv@EhrfoRrBa5DaBD;9Jp(V3yp|)Jboa2=O}#1 zU=&cjH(X-WFCEtyW2As5C4o+yd)Gp#gu5!q;OOuPIc538qO`W1OG%t&18dgxklB-C z17b~^<3UedqERtH;mx7eDkJvR%G1|4?p5x=5YDKQANjDXTh(l%*42@n<~_usSEa&` zE#Chc>u@H)S&K_w6~5Z@s*R{*^5$f2i#pVp82pnJi#5G1?XmMpdQC|B2$5BvxsE#< zvT@kgYkKC?ejMB=9bNet?An4e`le~LDkeuu(*XbxwOY6L>DPOz&X#xGva@IONv(Ni z4DXbsjNC78S=z7hbiXPwnUwlAvez-!;%jf5cJ5lv2#(x&aoH~n;c1N@b9&gcr;t|9 zAf3$hVOhZp{cB@+Sh)tLtMN@iVJq_6I%e4|T?KF5@9JT?E)6BnXii%Bcu7Ww{VDLr z^asbvp2OLnexUSVKTT{LR~pyU3)uHNe9MmugD)?V2NepYl=bwz2^Ex=KOeBO*{n5K zMO|}1NJC-C3k;l zm{%LDA!pfjFebhBIb>H3Kj&ICh0iq?Ep+nxu%vB^!z(N)FtJ&7LT#FXFFPF8VnZ(i zj}lRhz|_oiq=SILVJyoFzi1pRe#xU~XI-_mkGhTnacB@|)H@lIo~-(~ESdHxwR*c? zqjPbnQEP>U3`K`{dzceqXYezKbnvip#Bs{MFG_BN5Oro2J=K6U&W-Q$!DeS#E?;3C z_afc#6u&^(169SdXuP!?xjWlEQ=jf+G+gsurSPrE-b#D!Aq0KjgmKR2-Dh4NoTXz} ztT?#AzV>yhv#XEKRMTu(%q(II?0$9kyVsbGOvyvn5y`d*_a9KtK5KRHhlf=EgU!X< z{C3wlloMS(%M8NCq|?}_$)L-9!Cj%Jx2u=(^*rB*Q}w*>s}+3p8!IOlbR z@mAu}XU8Y*a@+diq5Lb2Iqa3;*ZiqhBZ-8iMK8+WEq)b4<`*-skNU)xlFP?K$BpK$ zN2DK(3T8l4B_;mm+D-<w!YD$J)wkX`?%}LvA`DGSuYB%or!gvo;3oVM z3^N!*TeE(bV3%gdfbt%tuhNzLTH@AfmmHj$mT*JX?QXfe>7P!6zLu#11z8Kl=is zu0sR?5o}-T+bxAfF}Rw0I+o6Nq&MjYG&Ki>N$6}CW|53-Hl?Vu!;5RZ*JFSLGT zzyOD^{lyDT6e&?5W!M5ukW->@t^F7seEF?`9bRSYLz~fbi4Jnch=6Fa3vpD+4ZEVe zljT~j(IE3fNEAt_$V}feW^2Rcg@F1>IepC7aI4GdBJ~~WUZiW734`0k1cgd? z#;|sXxb0+VO>;*{1l2NpLJZ(WmvrE=a*4*H#fMzLG=9-oE2l*?u9h5L7Li>Fcu@bd zL-IlUH`#G9*M`zzb?7Z_GYSp$fd{H+=Z1$v1_*}5O#E7FPpPvNI~p7Iyq#ZE)2A_y z&nRnnl!UuuYV#eu_hut8WSGCdRY$Ayf>L|u2#$xZiCK=O^Obqgf$a++3vXtRyR6}- zM?2rK<|YmMbe{3S*}Zy=lQWUoR&aeUq>Fxei34nj>YbNR3rnS7d>7Pw1+UQd0jT;N z))@QK`+Xf#Rd}zZjuHT?9YBWH6s* zv$QbnykV$Gh0Zlr*kv#nTa}meHje79w>I(53Kf=UHOs97ym6U@rKzv;(plNasPd_V zy7?lA&p;+j?ZMt?Ml~_*6x523qvfFso(6yvsCUV7wp@cDD zFzuB1Hlqoi0UG1OQOhbT`qsQ}jW{_V)d}UsDzZs~Em-XE`iuH&Xaobn;AG}xR|ZWVeZ~cAM5hR*Y#~K6tfYvBT@fa|8ShYj>pAqRBj$e zjVyM2aMgzqzdE5CB$nBfOp*)g_^_}{T^J0!?dn+lh(WL^@<)}bMqmjX$$e9zgp*Z_ zYeKv16s-9xi2Ft7aFC0NQ-i%sSlQ`e<;rF?%hjMBy?3rbtky6Jk-+9w$rkNkD&nSy zA%(dwX9R<6&BScWn+qYLp5ga5@hKW8%awH=yf}sZzbb&yP{gC_5jX4^RvFJE0E$8K zKZ{>RR&V_uxTM*|Qg?avdQ4TX<*{i&&-6|NZ)Nc1nWblAQJX%OLH1_ex=!t@8a)rg z;|PJ;S7$3;9HhfzdWF=b@efVB3oqr+_lSt{o!-jhF5J6z6_T`lVhpBwQv<|sH;PA z=h&K|n%f;<_SiZ=RfX+lo}s9yQEuPkKb(C+b{y2zPs+EOTMNInw78X|^HU`aIM>}V zzBDdruDd^&sRzv1J6hncERM!VraQ#*nlgl5_{sS{g$k78Y~<+XFbbbzhx-O8Md748 zJXJan;_r#f8*E|9&gcJTyQ_t)E*@iK6fL(7j>Ta==j#+oE~7VA|H=+BW5OhZA15sHyJ0QTm@n0rA|HKilZ*|&P6PA3BJZaqvtK_sG|#!( z7rV~{BQJlyP;K!$XCtBLv zvn$2P@bXBwY6AVb_=kL~ID_fL-S34Wl*14&&xo;F26VjPE)AubJ~86Rx zWiCoG&dqvW_ZdW%OTIUe>m$Q3n;>_m#yjJYvte_5@ZC4whp;W;pZy2Z7h9z;yfJPb z%xPa;C=mrd2csWfRcCzMRH|LrUb$h*6Z6Qwf2Dd7#M5K`yPG~f0$hqjRyb19y8m*u z0n420O+KSm;%Ttv1%5npdC&&K5$C_!4QJ|a0|l!_+>aLjt zd=Hy;KL#gGrtuN#J=GX?v%Sw41sPU;D*^N|#O^p}@)6ZB%qg6t#e5d@LRjX}l5(8; z^f58NC(E7SHG=OBoQnlp3(9 xbTI;b*%P4$0HUnnl0gH4y8_=(Q2I7iFS#$FNs? zyp#^pT5Y{|tzZUtv7;e5Fa;meNms}VP8MY1q4z$h50y-Wi_W$-JJ-!f-a4xgZB$iK zl1}HoaVTFS`o>y=i=nwh{zvI(X9+GB@D)~&mn4&uw}Kp^Afk^aF9`FkagwiRNtwVy zLKKr%`O?y%XqCVFjSbNqK3!X6IPraqX6X1?wG{odyh7%csdE($fqQgsGjjOY^@zTC zDwKDflHbC!b|?EaQ{zZ76>%%8L+ERmC$QDp&sRrnJ9YU@Z|yW6v#TqY$GyLbXjrr$ zjcB7R2eqt>tZ~c_j%|;rI>#7mL2AHdb}^j;wUn7Zd#=Uvxg2k_MuOZ)vv?)zq=Jb zD>ag#Y2Cfb7ZO;y$I#N5go^Ch^>K@z2bWlH4oM0$^#Xd61;C}T8y$^x8JvvyFC+T8 zz|c^0r^_T_5)ez8P321MHCZDV6_XB+7w7qs3bVeX4Y_r3F#Fb#K7t0zX(8{nJ?_O; zo!woV*K1S&Y1V1IT;J_K(s5EfIqE$M*K==*(d<6h;eY?|sdP8xe$ZEhJihv|*1SM#nJTEDtgYc$amsf~c%oezWyoxu@StZ z3x4H?X7VzN*hgF@iv?mOOo3lrd5&`{m(`6}OK9qyU!o=ub%s~y8Qdh0SOiQ)9ZX|G zU{YI!3HUO zNg2QybxlVq0xS2b#%{8Zf+@Men>r|plhp~+G-u1QyY0oLHLVtt_r`qcAfbV4d?pRQ z(m&^``sfWMWBzTLS9fFm4270UK0CZXK9pX2w$9WR*>OxN{c z!%*_t&Nns(E^Da69;CX*13qMC1{O|I>5NEvh(10C)em4+<3k_nS~r1^s(!`9;g*6sKCP&OP`P=mjlIben1I`YjZh1K;fq-~R` z9X&ODEe2SA-7T!bCG^@kWGqG@c!lN17C6dHx`C(|92)Bss9f@ zf^`9^^FQfN+_cK2)87%OkeIQeKYpy1LQDNcF{B8LC5R;}relwMOQZNX=I8gqOTt^i@KM=G_IvxFgILhq8QnoY*OW>3ns*SE zwxk#Bimt!i9+M=QfEN$Bw_50yw2HZ6pR9(-M9YDi^v@3&k#yPNP3;0{K#zwwjbi?< zhI#c-LxR?G8%ypnN9^5pMYN6Ft5G-f@lH>7lexMP+6uKx?~QGyq(|O0uqER|T#exn z{9=O@n>!a?cs;o-*1>hO^6*dcE6l=wuhVD?BLSs1xW`pSQYF<9TzqmFbDTX&=^#p0;zRB?pr5=>a4Ugefqug z2%vNavM)FSf^+}qrPLf0S_Enp>0C8=y;MV#3T>E@tPjrB$G(u2@%i`Fw*HzVn%Wm( z(tCGW>fUSjo7s3N#SVjd()IDYG!S^B@+0nLN6NcKN+A5%2E=Vr2-m0iPSz+{YY7lZ z=e4;w#Y>dqnu*M*;vIpm20_NUoPRYN&jiXh08&9vM z+jzEA#g@+F9%OORX%M_hJnnaZ6=ze#Tyn_t;Kd#Ru^?HPgzwilQ&@Kv5AXf)YN zcvgK^4$eD0rAMBsjJXw)FXIoU2LRD`8{^(_;O1O7pVwu9!Wp-yC+Id)jmzbg@utR8 zHa6VI>$tNvoh8%FMB<5iwi0EVI&SOGF}n1++cbk;UNwi~>6A8Zbyn)e49?Hur&j89 zakH<%#sZzUE_jhawgvV`+Z7p*y{19;9TjoaOz@yzC#g?tyO0?#|AP|r`%2Z}Q@Bni zuRT`0%hMx=?R6;J8TeV)EObi`QqC1M)oj1#kWQyW-5FH!2|{!6cd}j+-l#*sIs)N- z)Of(4UqLF6J9_-1@_%m^;1sol!(=#@jQK#ZGCcH2o=89%XiER=!3>K#Lj1J2&7>TF zKr(U2;@sxvpcTOl8qm^l8Q1eosqq+PIPI;#heLQTy3A?Qt6F$Bi=0;Wfe93#`zIox zpS)P&>F5&M(P||L5ZL6{4*4Ya#xirt$3EpKfBB;PEa=T#kKiMAMYu(zD%GVm#z(_p zV>orpZz^5imFGOy*aTJ=ock10y`xstzN^m5<3)BRvbaErF!miT&cyi=@{yy+mxQ;@ ztC5P3%R$g|XS=dq~AZ%$X`&m287 zB8j*q>y<0Sm|CEWt&^8t)3?zssYa@Dx`_sIC+5z2#NC?nfvhG;>$Vf$L&NEp(t!^$3mTMyto|pk9 zl1F;(9i7wxt5L2ZhcbC#5!tYHK|~%kwndyG9=@#^HkaID&EZP25|#QDZ1tmUDY>0* zAbtT2pk@u))pk|LaWb|EnV`Ahjsh}uP$2WT`a-)g z0&=)r^`Q56uy&yfO-6F0Y6@3;@$~0|PT49gqG;??oy)`+t;SbvTl6$r?q@n^zECFq zR2RP?>r#mQ@wpH%X`29;;8wzt} zNC(Z2D|%<+$HY}KoY5NY%+|y5sm!xgRWw~odIN6EAW!JB#!TI&Ivw%}viFZ6)xD~I ziI|^xD#?x~0?J6l*|k-skVPL}s&M3k`DS}MWVD;9Dzaepux;YS?i9l0>ihd@n?-*n zYx%k#Q#TfdMnlA1HMLs!3RTTD!+{~pG2A4Mf`>lSFNYZnZdk|nT0|C3 zqcx2yRARV|y|Kz?vb=AI6C7GECa7!SUJnJRe-oOZzn$!3I9p^)D^c^PpD8Q}Z~#>I zb@bJeWe8e#!$om(Hr#B?7F8zFS=~y{<-7CUi zg90TWsUd2^>0SK&FQ?RIrnM!>StKnehSt}`G6wXoRB-$_L*=*dj}0^=-Bck?c*AWe;UlBl2xlvgCyQ+wz3Kdhl-!P+ z4Vs$z$YkS;#u*+h=>BJxqr7)B#|#Ol>)YtZES274^52ug5)aZiy<}I27uys0y(@U~ zZdy1`D2)FBoDOua2r}N`CZ7~AVrPwUR{TNw_9DjKaC)k!t_P+nYDPU zu36_I2SR+G;>djj7Ti|C4ICN@y43*+W!v3UKNi#t4NuM+`a5p+v1zz^8CB|YMeAaX z+6r6XNrFIyo8{}FYohPQ#aH_!uP-sH?CAHC*xe9U-1_;Jt-t-!zzSaSldVZFl6R?c zdS0oRhci~Ozal8`qT&7rRK}Ddp->PFE|19}i@0evI3cdtS#vZS4?fR&?FB*QD6yea zt0;qmgSxEGy)77#e?a=775M$!`5I)pSYyR7V>TZ5D`)BwJ_G&MFxU>J?m8br9OrmbLNaV#HNREuvLqjZ)>XopuS5E52^XvaE0q-%~)038g`jZ_Pv-hyU5rKot}$por$Te{Cj+t2;GhEh~`lq1H7IXQri|C4C*sJS*n%%UPrunbPwy zlb92p#+!DtvPOKmHeZW;HuU1kBQ^z!N^iNdj?(XHy@^zYmG)wKD<|fy{V4$i+%H{Q zR5oSZaAS24P^VaV0fAn9#TH-gOg(kV@ATv;p)kp}tIwM#kqg#zcGR}I^AGYb(=~6; z)~*5#tL}09X2#Og{?p$FE}@aRCNOK%p|*usbXiT-Wi*<`iB$!x1@00j5ONM zxwL2bYY%EofpmW{^yln zNaS}q#B=3gJB0zzE{q3q>)k^UIA2Y`Zjd7+EW0M^48ig>?R`_j*@fjK|IYpSY51BV z?{H0jd`)pI*~E4snk@3L`N>)}m4K23(DzpotdvsaWmjqezNo^|%hG9Mdj(rpaXwic z0V|QlTWZG2Un;iYf1rm%f5Dzlyf9ekq@D33$Azj7{I%O~nv~AdmXb+)sJ;5^D=#D=$o( z2M9AGZ|wB2l*AKxPB7b}I%+kY^B(^vNzh=2M85DdfsSM7=g0q$T$=$sD`sO^+y99^ zxJLZZv9(BNKT!4WN!>r(0ith72EZPa-+xFz`Ac7c4@SfPzdtVerdP+kF@XU2qr3rv+!2pm3w@CADB2RZDQd-Sew2vXfl2HNjFuZD_&G zopH#iLyaN9Gj^OkuQ!GOk5jcLJf|b!dbOM9kD!rCzPjwN72#mMGw9%1q*!D9HWk+rHy{+?U+WQ>>OlCJ{NgP;LBV*oes3m>uVCLrOWS zGFz%aqqA5udyiv*V#<}K>AWIlI+>ddK|q5$V)$^Xm?tg9WxxIT?nl^_spE?M%}N}f zyVGK=yR+z~4ZNSt7YRr0N}0jiG+VuaoAC@ftvVEy($6tyMBH&%x`9i^frk}twPp^W z`6|&H(owGiX(L9{f8)Y#&)y(fPfh+TGJzz6L6D8!n(h6um)>;y4`c$9`CD3rIvK|M zG0PFA2NOFryVH826pFY=dGhHgUK(xT35>d;Vc1>@nJ9RoH?t+i4rfNTY9lGrrBbnQ zs_)+#4aUVRwu3&r`;#f)tFtb0mcd73pD&A~+Z>qO(doV4ncS|X=au{#n?AacE&1-0kRlu%@dz?3F*7 zBe^*l@@RT`aD7q6{$;wZ{8(3dR);;dC`P*xM_DRQXBwqnd}v{g$s!OT}73+dVL?5kCX9y3e6 zLSm#f`?A=t|I*y7rp z*iXY}qr^E&Q>uB_ftfi{2$WNWgnG8BcZN?eOzA%DB(fG3^pI97!jh_f#h9+Z_$YLE zl+V@4ix1?Th3}3b24mh`R}d zGo>5^qAb7>Z#?&6Yri~&?a_;6i`!|MI%6WU#Hdxm15ELKYX?P_(!I`Nx_J*D&eF$v zZ&*G$BSC>zh&5kMC56dQJTfblPURB8SSF0Y8!@Yo(7Dhio9lDEJfU~e|I^2Lhr_vT ze>_U`E=u&1M2QkaXBeZz5xqqV2GMH-gJDLE2tpDqgi)eLixR!}&S(+6cZ19@>Tk~d zJ?B18?(f{+`~Umyz1QCFde(QX&)V3Nbpsa3=;oVu-LV|1iTuxWeNDf;$SPB~nFAI_ z=Q1GR=cI`O=2M5$`$Pj#JnvXF;sBQ-lcho5>wCm5JHT~4=0O)I&1--}F*O4uMXuO5 zKLqfRGB#A9DPRoh(NZ$QC}3vz1AczgGkB(+i$x7hBexFB6yW{i$A~D0+U+Wp+^+$r z`x;`k&yP-#A9548HE{o(=zWQxtv|YyP9hj@iz^0r?`}|gO&+!&9h4)BT0~d7v5Tuj z2gE_BkQIzqgKxMUmB|5K&G%=`s&%)`0l=GsU7*MGL{7h=hgX7kBP%{h%~jv7QH)s(}D=4Bai(;#<@?B zXCEtPWWtB2DKUT85a1K!vmf&M6xnDhW`w)4Z!4$2)H#tqyhgV|$v?FP9MXS^VVC1m zeof)cN_|YA1rE#u1T#oiL61}!!tLWQ=YLk(7iDN=h-47Ke`PsG8t`hbiJ$E>2~lrF z(v+T*_3wYzt1dE{Z20NXpw%T6(CLYe5pi=O9kf~!o4s&6AkgKJ9mIK6eurg@DXzT; zM*2Q`zX2VVCrJskyrP@?&z#JAE}D$iFfNp|vZ_8qcIp^JukFrlEVe2jS@IFPkH9aM zbRGYUg&&tx=}|I$+b>GuO!gR-g;0(iVcAmkEv4a1^t?JegPt9C?DucUD|WxC$X2~{ zUb(>R=R0J;-@#0(_#RM(VuYJi1YoA>aSGSc4E%<@oE+`nBm6DeLJeCiEdp|pF5=FE zCIQm zSP(DIfdDar?};%>d`6jVD&A0VBTkQK!IsbNX_7??;XtyR=_0ixf0v z12rCT4e0IqdOVh+=0ryQyyD9(sEjulW?ti(TMa+*;*Q2bI*0;R3iF+g6AE$O7FYxY zxKI+4h;(Qn?&(dOXTxc&! zH{0)}*~O`9#!#wcE;sO6v7_a3g|1D%N!BM(7bQ4y48&~R_a?qjGvylGF)A*s^{A`+ z5U^1GGAE!L%!(; z8?fi%SsU?{KT?Y3E#Rib!Dv3cJCr`$$6^P*`^sb&HV{q$QU%I&k8vZW~Js<>ivWAIB7czf_j>*-*1p_%d zlSRmH>p+35r}b6acRupOvKAL;`UkJCa0ACq$>F;2UZxdkxWelJ2vEqhK8A`7wa*(~ zeiV3yvNlrFavJj&vl!c~+C@F?>U@s+o!#r{xEU=SSc|%Vt^ppXI3eG zclk7&*~Xt<7rj|R*y6J*$#LsSBTdp{BlbyI{@1TYOLm#GUYBQ4@scAQw@Q_;X^v;T zdd?^r-#I@9O8Y+R#`e!LP%7&Uf6Ql@1YR8u34xLhHpxI~YHzC1nIqB;Lp;`NgEX@| zjbeLuoeY3_OUe2C;W0EL0_caL5x!p=qMfcVB!+!xTK=)e!$TwbAshvO4nLpm9*EpH z;vk(FMZfl1pWxsb#b=fXi0LOF6r`CkT!V;IN-xSm4h)r&pCtzk%mI&ebT6mDVE`i4Xnp&8?W9({-@+dJ*n;k|cDEC$i`8 zO_G9;xzaReqj&7S;raRQ(X6v3fc~SlOSo%PBgkcWqR*h}CDMMK4g0*wo^rCt)POYJ zvkUBh9eS8>#rP=gQ>A@zi1ciGBmptcjIBL#L+ckEHLStsFl)}Z(5qoq`cC`X{v#HS z?+f~-qE_{;g!(e41ceYp^A0-g>b&qgI95rI6Pzg@pBOVb2=Wy*24kVQfkg}*>9sC5sc86PUi_=Oob=5bNAye5+pbwn!8ptyxi zx7+ZA*9_7$k1n>p*n=p+Nsd@72q3B5{#tmkoU5wJ`|VQsY8hZX)2@$_tT>9o>|k-Tr5W@*Y3xjpQRQIFrgV z_dAb(&yOMl$mz8a>p1Z(+*W43XzPNkkE=p!kQm4O9x=Qj3@IpQTv2v!3rkvjSDH-? zf&Urw7M+!U0?_KHq0E_@uFlhPkQ&P@2@Bjl35vcrSRQ$B@&qj4pIUT?FywY?J7s0@KshTRu?N@w4egII<@Uh(5d+ zeVe>3USMU_1nkbgx70~CsI*&^inJL)^uGecX|YN@4C$%J=`oRH&|t;hU0#I|EZQbn zZ7!c=S&gqnt@_jaj2r$ei3p%aR7WSD)p|>p_a^fqQcGT!tFlte=%fR*oct9jnmwsO zeb`r`J2G0{EO0YPcT_GtOsawlZ}}2Ey(n7{ZOks!QgIwkz5mP#n<$hHJ4LyOq&N5) z3_P}kq8X|=yLN!a0wF)7#2jeDi6@H;jRv@q1TCKO5u_x~`k*3-DBt8Gocji%`N!+g zyOU7ICtU9G9SCkQa$>CiSaw&xP?Ek;^Ex9pKn^AdyNNpkl$iHeOCJ+cz8MoN=y*~y zx+cSdcs+Pm3>oFu0xz{x4mxknWv0H_A)k6%@MM)&)6gj-p0GW2rR%MpVG&<5P{*!R zxMWY#eeUauzH#HS-$3G#P}n$H(_(dBx5v61Pjt4;iSf9N4d^?Eu>Xs=Lv1qnPr*sV zuQ{CJq84pQoYb0>kfR&U2&%xf6%di+~={!7p*juJLbo27)> zfSw2*R){*Taut0peC)$N71f_Fpfl~zoMCn~`4*Etr%Vg}2L`J}nQrTN%s1$*@(fLkQ|*06p=^gHUpA!pxVH~j ze(n|$YFpDe3<)jwjI$$A^D9q#Z1fa1tS0BXXE+At;S2*aJGOcUI?FPR2HSxP`T>7Z8xV%Yosi}WI%sbKBxwm!KTb9^Ev4Ed)O0y06!1iNrXR-Tvw z{|LD_1a@|$R;@|EA~s5M?t6_Nu)a=pIh~RGFxTk$JpQ;+m80de>{taK5@>0w>s)6$ zrzG&0gNj;DgysHqv)PAq;bbOyE!FFlDj})x|j+as+@&) z%y>A4Ka^8i203*x-zxVxO{U{o)v9$GyY6VJN7Gwce>&&h9}&_tPwTc6w7hzxt*&Hl zIheMpME>+YoE1s3Vt+Z{n2e#F6F$T#2aTz}nNPRT?;g!j<;ZxBda;|Ljc zp`o=Qy{+w3XjxLE|2{HV!expMb3eGye3L_h&zKr?efra*xWIXmA2!V#c-=wpZML!R zKGCv|^k65;po(o&d&f{J|8mSit!Rp;D6@)eeCayyW)JBKj?-&2CYop!EpMg3D95s# zpjVdq?)ZveJM<7H&w{TA$xb%PaRM=a*7jEWhjX9ZqF-R7svx(?(4}>T?J2+>T}VC8^w;-&N9>h>sw{wPalykk2B5a z()r(N3B65roFQCHFHI(R3if;QIK7}}CWdjA>GzM2nFKX(b)_1~WVU z7(h+LF6XTa?E)*$C+XDaYSdht1c}1!29oqN6f6VAzDEvnK8K0?d2@Y5T)<5}3}zI< zL=0ffzpYior7u+-Wg+jF0?$$`KM220fg7wquxQ)cA!QTD9bz;xJpK zx4*KXsi`9-}pC-nhBRroc#jD0<#lS$#_oVyXBo z|3ZVGLD)|3_hrRXv@ROhY!&1!LAmfa#W#Ik72$RsBgMaNN0l-=;r@%^8Zg*-WIO5f zVCK?u?kwv12h=sgUs!lIMgG-m7IBwq2qCf04X$NuoE}gaL$BZ&2g*Zgu6=T$s9}1P zGQwL2DEZpVCK)5!H2dB@NX){GG0Kj9mXJQrcej!1+)reFIumbbLqrE5Q<7x!*_Ody zIIM}xlZ8~)Hv&$EX2n3v=GRN?m3t(w_O{+P zVt1IUy>EpkDqJmO=V@_dn~F6*6T@8jBZ&9Z^-G_da%3tLg|mA`B9*;Pc;cmx?lD*H zoEnA8Q{;W?#?#(!b(O=gw{qN>X~D-L#I4zaM1NHhUU<*66Pd5!|lhG53PQ+7@<7As?uvq{u7k#pG0GaaDn zu4!1d!DeX{ts9J~}m3ec6r$&+kJ@-DAri$-jIa>y+kj$-Sj zFKMKW4+|MN9N|~Q&1K>-ZG5ewX%li1qR@(=wC{XcC4GCu zMEexbUoq@J5NW{Z)JyL&WFvaGp~_*=GN2J_>kOw4U-cy{7E>q#fRWE}z|tH}sO5Cr zMeHvmL^>)wyq)@xM$z{LWqQcfq7i)E--FAIhBt{Cq>*cdz!in=%tWLyvX}mpm{SndCHuXZYfsYl*7{yh;JZ-OIB`ORD`h&i8`b0p07EG*H(1xI@md6kMrXQbEeCVo4+*Qt1hBF#`>B1tm*rqXIjjVWtzr~1 zQxPKftE%(Jn-`!Fj8GrYaGfJ$kxsnLo1=K2>&|Lo3+}4eZ`%AR`=&f?tS*;hzqvWuxZy3BU}@k9Lw9+Zmw08cMRS#GhnxEDLa;-C%si zyW{R?-JuM*!=IV2Vn8KM;9@Cv3fXeMNK333<@2_H(~M{+PdJN*^a1tJ`}AdIdNFeo zoPkpQGSECBoymvs?+}k_NVk&ZRCXMAYWp=X|4Ah5uramWx1Mx;LBnw^F{8D1_Gp}t z%`G}0MIlJGx^1UFvE?k?zuG}+8L?Qo+?_<6mi~wIaer7JV*0{!e1*YYf9B^ociEYy zTUW8wF`4n+@6{GX5yEyPYAN2}MRabheWQ$8+nM99a9kUHh`n4(aQUjIpMWENSi=W| z#vNg82|p`RSN$^~PLGFa2iz7;@|fO^!85sBym;@52Nu29aYgoGv;ydR0UE=;bqze&v(>ht^_40OG(wF~&diE*fP|m&%Q=9*&tNo4IeRz+n z27REdQQ`jQF&vv7}za=%iKjJ5F$nO7dfJ;sg Wz|Q7Pmv{3m+@r3ltx~E44*ee;g}%}N literal 0 HcmV?d00001 diff --git a/apps/web/src/app/(docs)/mintlify-docs/images/static-chart.png b/apps/web/src/app/(docs)/mintlify-docs/images/static-chart.png new file mode 100644 index 0000000000000000000000000000000000000000..2b27ad430c405f9b5426e51379212056881997e0 GIT binary patch literal 18852 zcmb8X2UJwq)-7BZFpxxAf*@!iAUR1+h5`WrX|m*;bIzC$5Cln*L6jgMAR!P$blaZ*baZgR>|_O1&GMP`KjL-1NE+X{t}BbUQmSMy9> z81(S{!)^3%r6-F*_J-n-%NJ!&ags}ls$xDOXF22N;UBOiv54j*l4Gv$l46MP6UX%>w26(GZ?^eL zika{d*IvV5Fm-Ze@fVQ)$Y9IC1;ZcJKe6QSC;O!{BN~lXlAe%(i^)%#pTafabFs8= z&54ao2(FE);aW+RJ8cDNS?;9PH8!3Itv7b3gX=lRYI&MkT3$(qQkIqJZucsrunWOQ zE(;6y&Qrq|ok_lTcAh$Yx_ngBtpK;RwS}sgr!z1xi0*`E$eN8$PM)Qs^Br;7lb_Ya zZnrDP6c!fZpZ_qYHRi1170UnD@u}G(ZwK`iBr2LXQX3QkaZFA6rVXWclE7feJ z%I(P{jEoGQNkiCqd3JbANy^Lwv!LK}f}?~Tr4GY+1r=^{KSF=Z^%OGbl-gI#3oJ$iJ^e`h9JK0hro^7^%F*8g#!(M(gI9S>ZvN&z;dh#B`b_Z(5X9`SH(sl_f^izh@MhnVAWrmq_HU z-a5j~U1+^4Lcy$Xk%eXIGpB?^Rlompc(k4gHQ^!7JM0sK-AHfW4ec$jl`n6T6xam~ zMXaj%0kT&}sw5QJ%(SuC-NgzyC8dJ5^QATW zoR=9998wJq4|R7M*6=fUpJ zp__p`dmjX~I4Fx>C1~3F`ua}ym)HcFtH-o^hv_YJcq& zlHA1gxwbnn?u4tcmfGBT+Q;vv)+#g@@CVkV&z3M?cjV+!e*Yb8+Y2`e2lEEZ_ma%C zzHeN&@rRgeM)x{vJGX-I;6W!!{7ipx*{8wfm0Z1A<(e$~VW;Zz|3&v|k|`=uCoCw5 zs8FgmaGL&8$>@Nx=BwWy=(Qy*7Nj$8PCTk*M`)My!(x&m($#uVcuh?mIcmr5@ozJU zmtG8EAWbFsITHN5Qs6cFy2OP%E@2IABrs6wkfoXZ+QYnCm0x!D7{;1h?JWI3S7N#$3K|#J4rvy$yeuXJ5a;88>jq8n=uTqljnd z>+0_7EpIr^d;jd6k;Y)g6ZagKueNi_jw<-G4$&7N&wt4Hur*wr>G#*4Ip;kks}XBz zT@T_RK6&bwk&MFSg+1E%3;E6XDA7euBT^rh7}vC6GKC6W{Pv`Wem*R&BJazW+~-IL zlD+WOK7g{F8&{8gpfc-Ic6L+t3Rz$YkC;Y@GO`R##%3C{ONB%2jkMvYj?6%A*d@mEgGp;2TM6G?oWTu=+AtwnFA#yA>wr#d`MNAu8>F&ud$>Okv7}%EMHlC zm5v+E$MzLjKf-^Tf|av$r6+bbzIf&eD*d{DYjAjmI)y`YbT=J7GP6Yb7d#_hJKGnV zO7d~Z-mZ4*;F4z?-UV(sdlIfWS&Fhj?-GG|W9~Wp{L{%gCBzCnU%GVAcok(|olf5Q zlF@QevwhsOBnbcghr+(1X}#QMd*dR5>W>7>x-hn{FWl3)!0`77-g2xQ?!QwYH9BNMq3Wq~%SjfNi!wZVDxoqfSK@GK4l?aYdy`Vf;H--}>j&vR`(=wcwxUi*~ z=3Zt=-OPo*0W&}G!)>X|H5g<}%)rUzb<_TillE2vb@P^__;;woc-5O#zP}n6uq1lw z+7fA7{HhkU;(1HzS#A6x#$TSmkTQ-^2)lncqe(?Hw&OOQFfd?EJu8a8+{IJNv(@uq ztP<rQp8goaI)6H=3)Iyqu03^_z$!Z*ZwSSYYg6X=Qh)L_(Enq zo}5C?)A45UD-kCALAH+3(`qiOuee*xLUC`m{Mah&*{%WU1NDHUGjrRO+XcY*;p{?Q?lZ%t-0p?m;qvKp%rr(*UN(s_FBU=Snyj_ zE#2jKX60K;s^O)UBZk*3U6@H0A4kMJPPfKG71?v!Grb}*ZMVnOlz8dwxhgjdEsVY2 zf9Fvn!9M`21P^#a5|r?65~Y!JeIRQ+0p4JWvfBJsUNnA^3ThMf&Zg=-t0Oznj^epe zdE7w)_mnVoCs-hK1M*grK)?4E$Ezups94PhaTP=k;$5+qgpONLH=E*D+5KHVvAJ(R zaE=X`A^(e%fTKt>=Iv;lw>(l7zg=t5mMCp$d8N9#dTVFr?74IGrNjO{ed|+SQvgKe zIIgX(=6IJY)F95DWH$)8p5X8DPg^oCA55|@#)Tr7&LG9*)tc)0@NoyLRSniS-}s2Do(WIVg$l-@h+Feg_Hb5H;aN_)G>b5g)yA z#1C0*u|q=hThX^)3%J<7(O?gyEi;Uqy! zOpLOMit~uSy}fNrMyY+L7IUTqN>E{DJn6?nRsI%>oc>lJsBM} zK7ZBnBfQZJ4!g$Gv(Q__nC8F3nx39MK0dyDu)EZmr^&6Ns(R{l`7fhSWo5$5O37L& zH4gx*=B)1)Q&%`rO`Vp{SsG~;dsxBCQ<>RUG|tBH*ofMk@Cqj<6DQ|W$g`B(`mM<# zF1>G!YR!ng9(<(2l7qf;%Iyo-Q>3KKEG#Ds3{rIEFc>Zk^AcXKbpmq- zVd863lhv)h=qN$OxuoPbi@&pXp-S3t76W!=dHIE2g*(c1X($DT9g?G(y}HuKVBn_X z;o$*rK-hJniJ*RQ(H&f?}(fG{p%33_!+f29W&pAVB01SwaEC$1@Q3)Pqx_p#Ag zVbA7u%R4*sZ4L(n2xOlHWbzYoM&(;is=mN~%^7t{Sjeca;RJ(lpVSn&stKvHwe zoDe)HcV=)Aym0*D)usrVZ;|h`-S$7`Wzhs0Pke*V>drD`0qX_b{ zB0Fp8*-~Q$mr}Z;7hkI1%(`{!OqXn}^4DufT9}O)vml}-Pm^5@p+lu&UvWavtQ+j^ zYT=YWhs2{uQIqY(=rDsQ1%Ek_rVds@^Ufyd%6+|G?h@{(}XC?C56*KjSBR2G4w z>YR*1M92%Qfkbq)oEtvxXSLd^%xhcYl#6u_Tma})3 zzkfG9eLMeZ&eErt#@d;|^n|{mj6{6Q?qvNhSxZjw_wAjputz{z>`P04w8*$*-9G(S z)=KO;gMYyJP>+LFgXfvbkhQFi-pL{%`JJ_*&f~KhY2k~Ex%&%q$fA_;`AAATILuJk=>WNxgfa$5ZD9?n@2!Db*^w{eJ(;wLDtOs-lH{De`jI zrznFvS)@;2SPU?m-=c`dzd`L6Zq}(x?&xjr9yye^hh;-d<7dn7*J_pVbtEbCx+#*f zM7*<5kg~XO1Cf9pD5*$pemTU~n?Z(9UhMEb6^dI*e~*(PlH$&4#B@}-nH0a0RhLYyAR_J!ehi3exnY;rgo&7erbBewt3i{+w9+To+Wn+^hHr zricwc$pW7Ne`6QVF!+0*k_Z48^YAlAh2NKiWoE&Dpqq=mFn)^ia?y6jT@?KSeI4!5 zik}PV5tnkjz12g4WlQ>fr->meIx*Kg@?ON_?+8~iKC$P*yvR1qp`6g5?fgM+x>J6W zn$VSa*=Ul2{QX)FPmCHj{>A zhf~3em>t0P{AIL9YjqMY+@8fBgPgN)|L7h%!yh}fC|CQ%mazDf{em`z&U`sG$o!9& zr?hezLj~+Wb^IGWNua+4TqZ6W26oJ(VCpbfodp7fp z{Fu;&piq2MA@b@?>KCMRJ_c`LqV9~NmRm2_(exBDE*5aX3C7~jsO~qRiaWgiU+h=q zo2{l7zQO@4W54_n?jM(lj4n=1*L))1VPm<_&I*O=D#v5*Z*Nn-e8Cjp-;c}re_~iH z(Z{qMTvM-)=+7*pD^4i<*7~F=$KpBDVtQKsUqcv%O%d6fs4HwGd@I8_t%s}^?&VJ}ge1ltFRo`~WOO+?!%d4kr`pAZ{rGqJ*DU)#MhB48NUzz{rQe0JyOngM z=Dd)7tItwZ1+Tr6D@HDT0e>{?tHGTO_1<$&rFpP5~7lll5%!-US40% ze}_Y(!?WJLPp;v(Z6^1*9fj*JIK?1NA6^p?{zG=bq86V!e_k<<<^vRPK85zgkwKGsr zHP(et?kE{5Oy`q{A>g{%ym3{)vw=3NVHf}^eqQqE%|BiAe3 z7f?u|m)ieD0cdJsEJCW>Mqvt(SS0S2bU){{}zSH$#Jkhs5Nri;Lkt*e4|(K;qyBIn;*LF;o-neSx^(E zIf#9&1$GL)ow(~&^fMtI=*a%=W;Q^R@rem?28MQ+`nx68=TNne zNnV+?Jg=*-C*bk^W$C@S*f#zpnuf;^wKmmm0Tbf8`h~^(;5<-uDo6&ZR+vm0%tn=o z)un9)J^J>#ItUI>Zd}d;Gdp{zQSD==*)G<-y}gqpBxc>Y>NuBn2~mP*|(JJgrhsigg?6R6V?ex#G>y^Oh-n?YH zqPMpwWoRJmf7AzuVI^N*ap2u16D(45o)aEt^8r{R0{WeVM zz=oyp(1#4_$4z%q!}`|)>b4nQiz;w%m^xnFB12Jf>B{yL==HrbBQo$^ISzX-f7TcB z%PAy5^6a0`$TS~av>qurA-1*>J-D*wE+m#H`?T2StK!|eeSw7<0lt|ALil%~{#F8;#J73`aT+Vfj>_a@Qsl0PC8xGI(yY&9?G+?jcs%Dg?bjZA9q zW1@gf*;4f`O4w`lvSQ*iMj4G3nDD*MdgsvOghOHPZETz2wbDrr2DhXqPrJO_8L(dP zM6a!pAg`sWP0!h!?2|-9M}N*0)>QN8GNIAkHjPCt2=DVH*;pK>>$!gatGLr`c0XGA zV`42&ji}$-4LpDU{%Uhei&fWjO>|eP*Cb74RaKt&i{RkBxHfYhpD`omLdkpG<{ep9 zen?`-3rzFewCaEIT#S+bGcnsbl0z%-ibD1_|3KeI?iO1 z<_WEUHO9#3(!|7sr>7@ETAq$b6Z0sLKdK>+lCFiJtDmVn3q+ggT6!@`{47mf(!+8{ z^hQ^5eCD_JKJ0Rj*OEz9{?LUrmrEi`G5WQ48K8$Ul$Js#+$O#)UN>(%>vYmRE-5?J zJ6F^>IQV1@@l8cNpJy|}40Sv&Ozx2Z__Ad9Y2tpBJjiG>nf6|75ZPKYd*PW27Zf!# zC{a+2a^~dZsGnEDWN>|H<(v!=8HoR|5ogT*Ytry}{ZOtkqcKZGOB<9P2yZWSu*GQL zzsbDwXc)-{`ABR9VkNTSbHTn z1YD<;^?g^Q`S|!iyXdtQ6m%GBCE~992xV(7)Jt5{t_11KwD-PTC5(8|{^Ha7O0h}Fb@TXk#O_Yy#KIiw5|s<*`$#KH+dyk%-1d#)=-b)VQ2BT3=uBg`G7! zy;N*T>b%VGSKuVi=1|P1x^%v|%b%r~B;)Gp8aS~w*=91{6j^ehE0pNMi0;lQYi%AF zo}XB=Yb2N+0?71=(egKBqSGn)ie+VIAInOzFSqpCTpVQO<}Tfwfi2VUjsG~p|D~#8 zQAi3xDnXAPn?!<(=$@vAFA=6dhYTnJ%%eHskTlr#YFgR|b@~pF7V1}d(J2N}lE&d%waVy{z`=>E zvaR`&HfM@X$-?gJ}ZBm2`(Lz0V>}6)f*Ak_4#L;IL&)dRVBql3hxEdFoJKvez28Ae> zF%(M4cT=WZ2*c`(FIU@#p&A}?V&sBKA*Xx(pn4P#g4aqtm5BeICvtDz6d>Si2Al}} z-X}0xoVHw?s^7ElUd@(VP_xC*-5b1RZ(lycj9|5a51d0oLuC~enx1<&tcyA&M7OMo zb8)-}EvD6dey8tM+}QI9kfnY)=MxVDV{2J-rnqpSErf!_b1KE-+{~H~1)2XR6xqvb?lsNN z(JDH9diDtLUTc?XA8@EqEVUoxN^}95QO67dWv;45}Vth-*_xbanl=A9NQUZjsb}G%hkM(az)26KMKd>^jFADca0~FQ22U2mhyhuEU%; z-_Q2I_iJ&m z0?9aP6)BDFynK?8(IWLAf-J{DHGODrm1%T^oW;Zg+gIi^c8;NDEL^NWBrI6g4QhAE zAv#6E z2|Ta7Ile@UIVzeyXi~SY*=p4&u4IR1f5p;HOU~fVIr3tV~8ACKNPr!0aj4`0uya zPr+KHAG4~|#T>+Sn=gMWzv;U?NMK8d>wP21pB8-ivhwh=KXQn2=hL`BLe`X+UA1A? zEO_G>0E64w-7SWPuzwva(&9KqNT{!>MDApty(aHzfBkF{X$pa%qv`D-y586wh#D#u zz56}YKAVfDH%V%LcIBulBwh_!US6I%9UUEg^cra4g=P96l|voWU|vj4L-R#!sq$tV zmmU|^UQX^5)IwB?Q= z$H`h-vt7S_ohtuuXReSRRPxa0a}Y+q)&c=izHza$Mk?6oTF^bh*07Kazk3mIRx+OS zx}24Qz_K#d$d2=Ha!Q9F-XoE-iBw8(Aj~?m6yrEp<5V>?WU`e~g2Tfn+k}QIr&oT{ z#~N62r?UvVk($=@fpH4uxtC?AAMl!JU0fG9Z?t-jcDphTfVmB+y9lF9nBn&7ge|V@ zTY>S>pNor1K*9%+UML?QOHEDn^!C<}Rv^zY1CpoBg(yl`NBK!<5c`ri?&)=MPGn}7 zE3#ctjF{y9gn=Kqy*mpmlKUR22GF>9sbubKc$7 zmIH`o-}P=y@Nzthj3n4wbzAdZpZ$O1m}hLhUP6bDsVR|z^t{?xw1z^E_rdBli%OgT zF%!B5j&y6PL=x6zYIQvNj{YWDnt%w=mYFZoBWOD|kZI0?n>2yPAAw9Q3^SJ`l23#`7Yd8%}_rd#nA#goZp#+{|({ zHWXyfM)s$-T956k?{0gJk)z5#{4xU-O6Y3U-WN&fI&AOSw%z6g6+)8(04x+q4i1*^ zmo#WHVQ{EYw)O9vBYZACaJyax!_~5Almk+R|el$`~*VwWwCP=uWktWZ2Jyy$9c>k@CVe|K0ISo zM~)DtIpL|Sh8W)?IV>&&TP91iUI#;@Wfj)c@|c3Bz?a5P&grovyfqa%o~d!ZXVY-i z#0b~-Z5SA-(VxJ^Wi*__Ll%kFfmFh45wz#|IYl2_lLDv`(SU%^Cr^XbXyA+jn5PzV z=KzsJs;{pPb~x(1plwqSgTGeyHl{AbH({BdtgW}MI!ruKaQSCi&D^K8P4_y*H5*LE z>AwANKEEB;gN@RfmDLvRvDuyByyYR+PQ}YCESgrr@URD~~9OyTGxyko%I68hZ7+gn9hS(zyvQ|Cq3)XKOKdW_V3V$AsdHxCcP zI=ux)w{J9U(iz^6hM^j`siJZgVq(Et--+f}S15~{AA|&(K>n5%^PlW4RK3DgJhC+Q zr7N8rGuR7yF?w_yR@|g9oCzF6u)*MPL&?~hBoqNk*ko&h>IE9Iyw6t_{T|6*Y z_l>ng&t6r1pai$G~?haRXzu;DB^yKKzg)%ROh|Bv!p9`b$|KKev9-^c^I zJ^d}k^cZiJ02va-x(3f9l>sBf%Zk`wK|GBNGkF5tz`Zq zw2MG2BF)6q7tP`VQiIzFH<|0`;ks>pjURbV32Z8eH;9xB*kZPc5nb}A&3yR_*)30p zZvQue4`~xU`5Bp`3OM&$!zcok3Yt{w`=DnRpS^`KR)&(^bwx&lgWMDkImCRoco_V*E&-@H{sJ-z;+La!s4SAN4Ut_h>L&)r zQq%h-GGpqFp&9}P339nz6a%uqb>l)=I&|xE)$^utSpI=h2Nr-K9UaR4dn>ofU1vT6 zkA;-qYDM5{N{ufDnLU72FkB9w4J|F9KvRHIz`$tx{?QXa zPG**s^&Zp-$WF-2=7PFURxS1sX48cF%-QMMuz1=2Z6O}mZ%yjzbETOuMi~{A@6r>@ ztgNR30s?%}lrYvGbCS_A?YE70i(F83xbIIi8K!?5rJxo_9h{iltT~iu7hfa36;79~ zS*VY)9jZ+581{>U9i`!QjT|dEw_(QXZgh5vsKxT1@1q3Z;MKOV%>K8sOZQHh#TZi3f-bpS+8H8 ztmRqW*l1{M3>s^UScB20fWqJcWTC!`C3((yn+?;|&!FA>5j!$A(O|%EDl?!Iq@lCq zIlQp@VNUrxmkkfL8l|FAQWPWTB>?UIY)#--NZ<>!Nb~z3>inch9TIo^uLViT!MzqH zmCq0M5F3S~3AneQ0_Ui>GaC2o*~f*_VbYJI^`WPTiO08A#`f0I4ox95sM9NB3b^)l zFWoeEz$)859{%xII$%E2m=Wz31?A;wA|meAqPtbz0uN7+f$cLeRl>&^cr7-vD`?FP zyH(bMN>jY&tJ`G?kL^aZd!nTGe2B&m^<*lT)J;Jd(Jp%87zr@Ioc@{>CG1>GqmWtk(89sQA4p< z;C?6q5jfMvTZovL7@U_!sNxRohk&_;Vt3v3K-)YD3gQP=H}8NrrS1;h zw~@|mge?Ln!a*6l&>7C_H!zm#CGFy@RLjUQOA8+oujQEP7!*jv^0C;U>s=k7itJn$npEuNQ6#y55Q{WyHw6s9} zh#UB=pOci7q?&940P|;|z61(ZQKscNXGm!1QA1#!fLciU63xPI_z^YPp4J|IL2L_3 z5`|p}OhM0(Dz>hH#c|w~fQ!=eU?^OCU{^+0mjk48awlQXEumT@=*Yg4cDm)Cb&JM` zujqf2h2F6%-Js0L2S_)x;i`Y=!3G|jBYsu!lozf?2*w>YfbgJuH(#_}QL)3zKI20Z zJJ(odChMLL*e`ZmZ4vv0l`i6r0CFv&Hg!rSqd-<9vNm|@Sa=F&U3dNGv|YFH&C=3t zAWdY?fypH2`eUQzZLkfN{I(6!{xAUrcTh)&5Ar~8C-R9)P@jYuyi0OW^-mBU{wMUo zi)xyb&|3Ppd?P6=|)mM1XXm<(oQkoOmEwe!LW zr@`WBqn(F(;6y-h2ss4^@wz9H+6;d@u2p~zj=Z)PcEvjgMWE`U*MAdJ#{o)t&$I#% zLtsG;dT4?2L=XoFAdWlxcSC~X<(599dkkAf_<;qe1Azq$Z=NQGnvY${5b{cv^Mx~` z@rk@P!=23&2_H5t3Lfp>6*5FT)+d*Fk!9Fpfbq*WH*=b|KDhjWPLk*&U=#(q-s28r z`!tY6n7uVAa~^^FdJ+qa$rtYWf!f$oLN_x<(`QgkV#d!x*;ViYXFXQCM9Sx~|8H(S z3i8MnSZ8clSh6w9u<3tD?c?%r2QH(*1CCUKvQV&KLM1(x@@WtVFr<>kWFSvCxRub| zu$#BJw(^(}^AkP6ql3W| z#5Oq8K~PdC_7h_Nc#V@ydCxcT#~3A4y?D)Hh~aEQ zmEIAAHbJYy2AYlePafz;?93Vg;(i&D*DIXLC+Lp~ThbHGyLc<-wR^Q04Zsu9wrw07Nqwh)6zOq1- zxM4PKRD^e7xcG@7E)0Nz;N()Wx;uJGUprC3C?}SAU1AGrxy9*@RwS9L996Tg%lRW# z+iQPLjdEW01o*QM72tkNA)*2R&kVb_Q#d~17D&t|_|}TF47>CeXuw7DO}YrAOMO^a6HToo%TQ7&k#iwyg2^yk&%-Z!vkvj|LG$G z>EpiCx>ZmpGJUgGV`-g)9~<$2t3&@#G&ahamY_NnM)---E-4(83`u4-$?Vdj{J ze7Cdp#k=PS&w|Ov^Sn$hzcXO$+r)TrCUqHa&Y%q(!PY}!z z3VU<+9SXQG5vPY0BV!0ZPL36Xj0N`LPVkOal&)=VW`ngsok7;R>kc^7AUOWzPy>OV zqVrX3_zy5Bxj8k72#t)409fiMvC-5I*mtw9TK~~fprfL4Lr(5X;4Ux&0_1-dd^G2e zFB#!c{XzE;nDzlY(>{ayyg5r73P~+6$HjiWyVA=Ak@};UZfm_WJ@x6+r(ZLjL0}eW zv8SM-3Q9{G4%BgUbR=PZZXgzI@L4s@ZmLRs7wRzjaLX?>w}!F+8Kc!3jHw?Rxt~OZ z)_(>IG0j!WXLJ%386=QVsdhHYDzPw z-64qX`Hq2v_b)?)@b$xWc2eBAqsQB?0E&Cq5*e@C0#cA}I(%$pLC>7Q3*6*RH%JZa z0jgOJRbu;i$NAo^KB3{43gHZDKf;sYbB5xC`=^205d&{H#kUi7PDQ7swWr?<;=)OJ z|GEM&>#9929>&aT^!b=lvhXLV!|gjLN#Mc|$_QBVE3jw2CW|2O=Z$_<{~Lqr1%{oU z_`~i#s{;>vrG&1Rjj|@;Ey9Egw;_ln=S-M`tp(>bl|r=`aY2mo9!T_0fL%o->F?ja zbBXI~Yd0e*4^X{O5-~%;3QmiH&o05+&G~{^1rkkRZvWOj17~;ko;H7aSynIqCAs;y zf3bGwdoFzX>WQsDlr{|A-IPRSj*`Zm{kvg$_zcpu>BzJgsZ4*`#t4uqd5(#i{djro zT{}py_wLS-9qqtkxj~)CQ0&|R1_*=~s96hIzRaU#zTP&ST3JI8heA2G>49X>;CLCh z*wf7}c0JS$uAS!o0U``Zay>!FdE+V5}i|V_*Kmh>W zx;zY^37p6inO}TkUC-Vdx{$~_QN)vYwFB85!mt7?ao&8;2N^;qfoC)S${$YO@Yh-4 zy4inqB0~$N8asR{(y_@e*a$Atve z99lK|)Gj{f?7zq=^nzaX$TewSh<8a~YnyN82&MI=EL-v=nsn-EWrxRBB4 z)c|-nkb(d3JAJ_WoxWoO3y~Cyv4$Su6OKRuLbX*i^3e)K7+Crm4J zwu1E4>pRVXif|_zeTuXJb{ulS{N;ViHsdVb?x2xrzXNT6r`B#XY#U@aVl2p^Z?qd;)23YJ$6M6_{%6Y(VnJgAhUUB0!DzY#EbW0teYgXlhK z#BLToHbvn1&cX&(P!2hw2n5Y~>{r7b4bumN?&FATT4)h%-XBa%LZWw_)oWbWGlcrm zSeS|i>gy!QstJfv|AT<*uyFkz62g+>WI>Tf)l{t$A|b339|6$niW6Ch`Txa-3<0jC zzLlXG>T)0tu4})yykBo@1XP3OpgE8Z(9JVCGb0ClQM{OkeaTcMC4@TW1F={s-|A?H zhG=a8)B0&}3c@PqCgeFvZjI*^-~ZJKj8kr6 zbUzE;-qYUE=L+eMO zfmA~njZ2>$G$~(UWyLyzt+!PB9SBlhyGd2P)eFKXp%VMLU-2gscf0eRr-3^W9cMoK zHl_;fS0_)t_Wa}W#f$fFI9(w7xv+}RMC0%8Ph}4{r8{Z?j676N+7JgdxIl7yK?sWf zm>!PP4TWYL9>m9k5H@+4KcRoMH3Di)o=T=Fv8#EjQ;?w|o1I=eQ&3aOnwy&kngJ^U z{b4GFLzxj#Ap64f-(BbfQUOqRWq&|8+*vo_CdqB-f6yH_)zo6-LSP9pKJb>{#;2yD zV`4C%D=oKZRz*iefsN~^KaC2gVZDLthrm}lk2jGY>`h4(I}A%o?o2a+v$F|Is}?f8 zNSj`u0;iCe`}{>T8d|DOq8h@HO?V8^EKs0vmn*xX0E5&D4g1ytNep1qWOe)t(4N^p zd`Wa+46PRbwW%2$YY5!*%{HXnj~sg*asU6H9~OWj688GPHSYiCUnB@BXY*9wYCn|# zbE>EW%Y=?yPitRj*40Y?8kt8mVS#(yq|{aLR08<=`*#$Q*v4mOzStC2 zJgaPFdm~T* zHFX2Ny_5#T{BvSL8oWAMMaI%3Oaf^VyVn25Yf^Y#!6x;87aOyJP;9X9@tuW6edw5P z1gBD-goT~qQnfZ1Nu&$eL+fwI$jG!E6GYm_VD@;LV-qC=q4?moge2!Na8^lJ3cWTK*|#QapCkLvQ4AbdB+P<$fL}E-GJ-C? zVwE`t5MSZv6db`Y6%`Xx2b8BL{5}Ghz10O+1k$Q@XQg0_1|uaCOG^fdr)+}$FJy4} zp1&LCF463ykA|}H8N_1?LgRdI(Zhv-#Tpama5Sd?PdvH3VV`Hjacr&!)ap z3LyJ-89?-G96oz1jZgjechpVZ^=I?#A}ST3VX{;}wG3ak#@)Mj2@P#~-;TVS>zdfi zGstT_`0n!~K)|}I3G9JinHc!z+%g%3V$}f1gNiXTP`VUo#>K_;YhfS`^kseLB>1<6 z7Q+jJ8vi)G;k&vm)km7z+q1#wckILogB61#ZhCrtdU_Gd%Z`ac4qqiUakZ0eNp0b( zW6<}2vc#3GnDu;{o2_9huDP~!7k=_#du>WpS^1ipS{G9fFFf2?RnFpT@+a$(vuDmI z8+l#3_R*|yiJy;eUK{_k*}wWY5yJIwr>6$YfWKzDLqYJzGNZ*}TB-`1U0hh%*!Wo0 z7rOpSDR`{-RX6p&Q`&iXOPVzref#Qh!^L1~L3$&=F|)T45nu`gvFjpkJ8CX*y*$@N z^LSi8JRtYR+ERBO75qxaDA4qXVdpAug77;ab`j~5XwzqXwjR`CM4Q;!TWeQT&~Sk@ zMwo9X{>*PVos1ncaNCy10}cK%6BB6OwV>U2fxY~9Gif-D>v&dFqM+TAygYV1#clBy z#cc<_im~u}GIj+1?gmwM!?;?;`RHvUL0?}YT16zBUc$R8p{F~ToKdUVR|MQ0j90Eq zKbiZ{y_t7t)_$;4QvNG-;&;CV(ry6^J{%-ox7n`S1vWqC01rori;E*yzz>qeOIxfxvg2efdkPt#c(A(<4!f-X5 zLCPMU6viMm6?H(;&EPH9^%eJ?qaf3y#tFJ2CX18 zU>3Uyo98LW)Utk4%Im$b(2LF22bG!Yd)8QH?LuTbJ*eX z<;(HU$|v`y=9+7&_bm>^*Sl0@U=F$anZ?C%AVBi;f3UOh-RQFrNF5;FSj>a>=qX!i zpd|s5;VY-H2AMQTzc5(Qq2y(OX_eiRua`x??RE#~wH)N;E#0lz9b5_nj|D9~J-tk^ zd0SWoumCrTc*FYF%HP4 +```bash JavaScript & TypeScript +npm i @e2b/code-interpreter +``` +```bash Python +pip install e2b-code-interpreter +``` + + +## What is E2B? +E2B is an [open-source](https://github.com/e2b-dev) infrastructure that allows you to run AI-generated code in secure isolated sandboxes in the cloud. +To start and control sandboxes, use our [Python SDK](https://pypi.org/project/e2b/) or [JavaScript SDK](https://www.npmjs.com/package/e2b). + +Some of the typical use cases for E2B are AI data analysis or visualization, running AI-generated code of various languages, playground for coding agents, environment for codegen evals, or running full AI-generated apps like in [Fragments](https://github.com/e2b-dev/fragments). + +### Under the hood +The E2B Sandbox is a small isolated VM the can be started very quickly (~150ms). You can think of it as a small computer for the AI model. You can run many sandboxes at once. Typically, you run separate sandbox for each LLM, user, or AI agent session in your app. +For example, if you were building an AI data analysis chatbot, you would start the sandbox for every user session. + +## Quickstart + + +## Code interpreting with AI + + +## Learn the core concepts + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/cli/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/cli/commands/index.mdx new file mode 100644 index 0000000000..7bbcd56e3d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/cli/commands/index.mdx @@ -0,0 +1,283 @@ +--- +title: "CLI Commands" +--- + +You are reading a legacy (pre v1.0) document. + + +Build your sandbox with our CLI. + + +You can use `--help` flag for more information about commands. + + +--- + +# Auth + +
    + +## `auth login` + +Log in to the CLI. It will save your access token in `~/.e2b` file. + +```bash +e2b auth login +``` + +## `auth logout` + +Log out of the CLI. It will remove your access token from `~/.e2b` file. + +``` +e2b auth logout +``` + +## `auth configure` + +Configure the default team for the CLI. It will be used for all commands that require a team. + +```bash +e2b auth configure +``` + +## `auth info` + +Get info about your current user. + +``` +e2b auth info +``` + +--- + +# Templates + +
    + +## `template init` + +Creates a basic Dockerfile (`./e2b.Dockerfile`) in current directory. +You can then run `e2b template build` to build sandbox template from this Dockerfile. + +```bash +e2b template init +``` + +#### **Options** + + + + + + +## `template build` + +Builds a sandbox template defined by `./e2b.Dockerfile` or `./Dockerfile` from the root directory. +By default, the root directory is the current working directory. +This command also creates the `e2b.toml` config. + +```bash +e2b template build +``` + + +Running `e2b template 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. + + +#### **Arguments** + + + Specify the template you want to rebuild. You can use the template name or ID. + + + +#### **Options** + + + Specify the command that should be running when a sandbox starts. + + + Specify the path to the config file. By default, E2B tries to find `e2b.toml` in the root directory. + + + Specify the name of the sandbox template. You can use the template name to start the sandbox in the SDK. The name must be lowercase and contain only letters, numbers, dashes, and underscores. + + + Change the root directory where the command is executed to the `path` directory. + + + Specify the path to Dockerfile. By default E2B tries to find `e2b.Dockerfile` or `Dockerfile` in the root directory. + + + Specify the team that will be used for the sandbox template. You can find team ID in the team settings in the [E2B dashboard](https://e2b.dev/dashboard?tab=team). + + + Specify the number of CPUs that will be used to run the sandbox. The default value is 2. + + + Specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. + + + Specify a build argument for the Dockerfile. The format is `key=value`. You can use this option multiple times. + + +## `template delete` + +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. + +```bash +e2b template delete +``` + + +Running `e2b template delete` without specifying a template with the `[template]` argument will delete the template defined by the `e2b.toml` config. + + +#### **Arguments** + + + Specify the template you want to delete. You can use the template name or ID. + + + +#### **Options** + + + Change the root directory where the command is executed to the `path` directory. + + + Specify the path to the config file. By default, E2B tries to find `e2b.toml` in the root directory. + + + Specify the team that will be used for the sandbox template. You can find team ID in the team settings in the [E2B dashboard](https://e2b.dev/dashboard?tab=team). + + + Interactively select sandbox templates you want to delete. + + + Don't ask for confirmation before deleting the sandbox template. + + + +## `template list` + +List your sandbox templates. + +```bash +e2b template list +``` + +#### **Options** + + + Specify the team that will be used for the sandbox template. You can find team ID in the team settings in the [E2B dashboard](https://e2b.dev/dashboard?tab=team). + + + +--- + +# Sandboxes + +
    + +## `sandbox list` + +List your created sandboxes that are running right now. + +```bash +e2b sandbox list +``` + + +## `sandbox logs` +Starts printing logs from the specified sandbox. +If the sandbox is running new logs will be streamed to the terminal. + +The timestamps are in the UTC format. + +This command is useful if you need to debug a running sandbox or check logs from a sandbox that was already closed. + +```bash +e2b sandbox logs +``` + + +You can use `e2b sandbox list` to get a list of running sandboxes and their IDs that can be used with `e2b sandbox logs ` command. + + +#### **Arguments** + + + Specify the ID of the sandbox you want to get logs from. + + +#### **Options** + + + Enable streaming logs until the sandbox is closed. + + +## `sandbox connect` + +Connects your terminal to a running sandbox that you created via the E2B SDK. +This command is useful if you need to debug a running sandbox. + +This command works similar to the `docker exec -it bash` command in Docker. + +```bash +e2b sandbox connect +``` + + +You can use `e2b sandbox list` to get a list of running sandboxes and their IDs that can be used with `e2b sandbox connect ` command. + + +#### **Arguments** + + + Specify the ID of a running sandbox you want to connect to. + + +## `sandbox create` + +Spawns a sandbox and connects your terminal to the sandbox. +This command can be used to debug your sandbox template. + +This command works similar to the `docker run -it bash` command in Docker. + +```bash +e2b sandbox create +``` + + +Running `e2b sandbox create` without specifying a template with the `[template]` argument will create sandbox defined by the `e2b.toml` config. + + +#### **Arguments** + + + Specify the template you want to create sandbox from. You can use the template name or ID. + + + +#### **Options** + + + Specify the path to the config file. By default, E2B tries to find `e2b.toml` in the root directory. + + +## `sandbox kill` + +Immediately kill a running sandbox. + +```bash +e2b sandbox kill +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/cli/installation/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/cli/installation/index.mdx new file mode 100644 index 0000000000..02fdcf57e3 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/cli/installation/index.mdx @@ -0,0 +1,27 @@ +--- +title: "Installation" +--- + +You are reading a legacy (pre v1.0) document. + + +You build and manage sandbox templates with our CLI. + +The CLI is distributed as an [NPM package](https://www.npmjs.com/package/e2b). + +## Download CLI + +You can install the CLI with following command: + +```bash +npm install -g @e2b/cli@latest +``` + +## Login + +You'll need to login to your account to start using the CLI. +You'll be redirected to the browser after running the following command to finish the login. + +```bash +e2b auth login +``` \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/examples/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/examples/index.mdx new file mode 100644 index 0000000000..c8f751203d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/examples/index.mdx @@ -0,0 +1,149 @@ +--- +title: "Examples" +--- + +You are reading a legacy (pre v1.0) document. + + +Here are some examples of how to use the E2B Code Interpreter package. If you are missing something, please let us know. + +## Minimal example with the sharing context + +The following example demonstrates how to create a shared context between multiple code executions. This is useful when you want to share variables between different code cells. + + +```js JavaScript & TypeScript +import { CodeInterpreter } from '@e2b/code-interpreter' + +const sandbox = await CodeInterpreter.create() +await sandbox.notebook.execCell('x = 1') + +const execution = await sandbox.notebook.execCell('x+=1; x') +console.log(execution.text) // outputs 2 + +await sandbox.close() +``` +```python Python +from e2b_code_interpreter import CodeInterpreter + +with CodeInterpreter() as sandbox: + sandbox.notebook.exec_cell("x = 1") + + execution = sandbox.notebook.exec_cell("x+=1; x") + print(execution.text) # outputs 2 + +``` + + +## Get charts and any display-able data + + +```js JavaScript & TypeScript +import { CodeInterpreter } from '@e2b/code-interpreter' + +const sandbox = await CodeInterpreter.create() + +const code = ` +import matplotlib.pyplot as plt +import numpy as np + +x = np.linspace(0, 20, 100) +y = np.sin(x) + +plt.plot(x, y) +plt.show() +`; + +// you can install dependencies in "jupyter notebook style" +await sandbox.notebook.execCell("!pip install matplotlib") + +const execution = await sandbox.notebook.execCell(code) + +// this contains the image data, you can e.g. save it to file or send to frontend +execution.results[0].png + +await sandbox.close() +``` +```python Python +import base64 +import io + +from matplotlib import image as mpimg, pyplot as plt + +from e2b_code_interpreter import CodeInterpreter + +code = """ +import matplotlib.pyplot as plt +import numpy as np + +x = np.linspace(0, 20, 100) +y = np.sin(x) + +plt.plot(x, y) +plt.show() +""" + +with CodeInterpreter() as sandbox: + # you can install dependencies in "jupyter notebook style" + sandbox.notebook.exec_cell("!pip install matplotlib") + + # plot random graph + execution = sandbox.notebook.exec_cell(code) + +# there's your image +image = execution.results[0].png + +# example how to show the image / prove it works +i = base64.b64decode(image) +i = io.BytesIO(i) +i = mpimg.imread(i, format='PNG') + +plt.imshow(i, interpolation='nearest') +plt.show() +``` + + +## Streaming code output + + +```js JavaScript & TypeScript +import { CodeInterpreter } from "@e2b/code-interpreter"; + +code = ` +import time +import pandas as pd + +print("hello") +time.sleep(3) +data = pd.DataFrame(data=[[1, 2], [3, 4]], columns=["A", "B"]) +display(data.head(10)) +time.sleep(3) +print("world") +` + +const sandbox = await CodeInterpreter.create() + +await sandbox.notebook.execCell(code, { + onStdout: (out) => console.log(out), + onStderr: (outErr) => console.error(outErr), + onResult: (result) => console.log(result.text) +}) +```` +```python Python +from e2b_code_interpreter import CodeInterpreter + +code = """ +import time +import pandas as pd + +print("hello") +time.sleep(3) +data = pd.DataFrame(data=[[1, 2], [3, 4]], columns=["A", "B"]) +display(data.head(10)) +time.sleep(3) +print("world") +""" +with CodeInterpreter() as sandbox: + sandbox.notebook.exec_cell(code, on_stdout=print, on_stderr=print, on_result=(lambda result: print(result.text))) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/execution/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/execution/index.mdx new file mode 100644 index 0000000000..0be12003ba --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/execution/index.mdx @@ -0,0 +1,198 @@ +--- +title: "Code Execution" +--- + +You are reading a legacy (pre v1.0) document. + + +You can execute code using the notebook module, using the `execCell` method. The method takes a string of code as an argument and returns an object with the results of the execution. + + +```js JavaScript & TypeScript +import { CodeInterpreter } from '@e2b/code-interpreter' + +const code = 'print("Hello, World!")' + +const sandbox = CodeInterpreter.create() +const execution = await sandbox.notebook.execCell(code) +``` + +```python Python +from e2b_code_interpreter import CodeInterpreter + +code = "print('Hello, World!')" + +sandbox = CodeInterpreter.create() +execution = sandbox.notebook.exec_cell(code) +``` + + +The `execCell` method also accepts following optional arguments: +- `kernel id`: The ID of the kernel to execute the code on. If not provided, the default kernel is used. See [here](/legacy/code-interpreter/kernels) for more info on kernels. +- `on stdout`: A callback function to handle standard output messages from the code execution. +- `on_stderr`: A callback function to handle standard error messages from the code execution. +- `on_result`: A callback function to handle the result and display calls of the code execution. + +## Streaming response + +You can use the `on_*` callbacks to handle the output of the code execution as it happens. This is useful for long-running code. You can stream the output to the user as it is generated. + +## Execution object + +The object returned by the `exec cell` method is little bit more complex, it's based on Jupyter. Here's an detailed explanation in the [Jupyter documentation](https://jupyter-client.readthedocs.io/en/stable/messaging.html). + +It contains the following fields: + +- `results`: A list containing result of the cell (interactively interpreted last line) and display calls (e.g. matplotlib plots). +- `logs`: Logs printed to stdout and stderr during execution. +- `error`: An error message, if there was an error during execution of the cell. It works only for Python code, not for system (`!` e.g `!pip install e2b`) commands. + +### Result object + +This object can be created in two different ways: +- Evaluation of the last line: If the last line of the code is an expression, the result is the value of that expression. As you would expect in REPL environments. +- Display calls: Calls to display functions, which can be used to display rich output in the notebook. E.g. [`img.show()`](https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.show.html), [`display(img)`](https://ipython.readthedocs.io/en/stable/api/generated/IPython.display.html), etc. + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by [ipython kernel](https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics) + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, it's always present for the actual result, +the other representations are optional. + +The result has those basic data types: + +#### Text types: +- `text`: text representation of the result +- `html`: html representation of the result +- `markdown`: markdown representation of the result +- `latex`: latex representation of the result + +#### Image types: + - `png`: "base64 encoded png image", + - `jpeg`: "base64 encoded jpeg image", + - `svg`": "svg image", + +#### Other types: + - `json`: "json representation", + - `javascript`: "javascript representation", + - `pdf`: "base64 encoded pdf" + + + If you want to integrate your own display formats or how to implement them for your classes, you can read more in [here](https://github.com/ipython/ipython/blob/main/examples/IPython%20Kernel/Custom%20Display%20Logic.ipynb) + + +### Logs object + +Logs printed to stdout and stderr during execution. Examples of logs are print statements, warnings, subprocess output, etc. + +It contains two fields: +- `stdout`: List of strings, each string is a line printed to stdout. +- `stderr`: List of strings, each string is a line printed to stderr. + +### Error object + +An error message, if there was an error during execution of the cell. + + It works only for Python code, not for system (e.g. `!pip install non_existent_package`) commands. The system commands are executed in a separate process and the output is in stdout/stderr. + + +It contains three fields: +- `name`: Name of the error, e.g. `NameError`, `ValueError`, etc. +- `value`: Value of the error, e.g. `name 'non_existent_variable' is not defined`, etc. +- `traceback`: Traceback of the error. + + +## Example how to interpret the results to LLM + +Here's an example how to return the results to LLM: + + +```js JavaScript & TypeScript +const code = '' +const execution = await sandbox.notebook.execCell(code) + +// There was an error during execution, return the error and its traceback +if (execution.error) { + return `There was an error during execution: ${execution.error.name}: ${execution.error.value}.\n + ${execution.error.traceback}` +} + +// The execution has some result, summarize to LLM, what are the results +if (execution.results.length > 0) { + let message = 'These are results of the execution:\n' + let counter = 1 + for (const result of execution.results) { + message += `Result ${counter++}:\n` + if (result.isMainResult) { + message += `[Main result]: ${result.text}\n` + } else { + message += `[Display data]: ${result.text}\n` + } + if (result.formats().length > 0) { + message += `It has following formats: ${result.formats()}\n` + } + } + + return message +} + +// There were no results, check if there was something is stdout/err +if ( + execution.logs.stdout.length > 0 || + execution.logs.stderr.length > 0 +) { + let message = 'There was no result of the execution, but here are the logs:\n' + if (execution.logs.stdout.length > 0) { + message += `Stdout: ${execution.logs.stdout.join('\n')}\n` + } + if (execution.logs.stderr.length > 0) { + message += `Stderr: ${execution.logs.stderr.join('\n')}\n` + } + + return message +} + +return 'There was no output of the execution.' +``` + +```python Python +code = "" +execution = sandbox.notebook.exec_cell(code) + +# There was an error during execution, return the error and its traceback +if execution.error: + return ( + f"There was an error during execution: {execution.error.name}: {execution.error.value}.\n" + f"{execution.error.traceback}" + ) + +# The execution has some result, summarize to LLM, what are the results +if execution.results: + message = "These are results of the execution:\n" + for i, result in enumerate(execution.results): + message += f"Result {i + 1}:\n" + if result.is_main_result: + message += f"[Main result]: {result.text}\n" + else: + message += f"[Display data]: {result.text}\n" + + if result.formats(): + message += f"It has also following formats: {result.formats()}\n" + + return message + +# There were no results, check if there was something is stdout/err +if execution.logs.stdout or execution.logs.stderr: + message = "There was no result of the execution, but here are the logs:\n" + if execution.logs.stdout: + message += "Stdout: " + "\n".join(execution.logs.stdout) + "\n" + + if execution.logs.stderr: + message += "Stderr: " + "\n".join(execution.logs.stderr) + "\n" + + return message + +return "There was no output of the execution." +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/installation/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/installation/index.mdx new file mode 100644 index 0000000000..de2f260ac0 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/installation/index.mdx @@ -0,0 +1,61 @@ +--- +title: "Code Interpreter SDK" +--- + +You are reading a legacy (pre v1.0) document. + + +E2B's [Code Interpreter SDK](https://github.com/e2b-dev/code-interpreter) allows you to add code interpreting capabilities to your AI apps. + +The code interpreter runs inside the [E2B Sandbox](https://github.com/e2b-dev/e2b) - an open-source secure sandbox made for running untrusted AI-generated code and AI agents. +- ✅ Works with any LLM and AI framework +- ✅ Supports streaming content like charts and stdout, stderr +- ✅ Python & JS SDK +- ✅ Runs on serverless and edge functions +- ✅ Runs AI-generated code in secure sandboxed environments +- ✅ 100% open source (including [infrastructure](https://github.com/e2b-dev/infra)) + +## Quickstart + +### 1. Install SDK + + +```bash JavaScript/TypeScript +npm i @e2b/code-interpreter +``` + +```bash Python +pip install e2b_code_interpreter +``` + + +### 2. Execute code with code interpreter inside sandbox + + + +```ts JavaScript +import { CodeInterpreter } from '@e2b/code-interpreter' + +const sandbox = await CodeInterpreter.create() +await sandbox.notebook.execCell('x = 1') + +const execution = await sandbox.notebook.execCell('x+=1; x') +console.log(execution.text) // outputs 2 + +await sandbox.close() +``` + +```py Python +from e2b_code_interpreter import CodeInterpreter + +with CodeInterpreter() as sandbox: + sandbox.notebook.exec_cell("x = 1") + + execution = sandbox.notebook.exec_cell("x+=1; x") + print(execution.text) # outputs 2 +``` + + +### 3. Hello World guide +Dive depeer and check out the [JavaScript](/legacy/hello-world/js) and [Python](/legacy/hello-world/py) the Hello World guides to learn how o connect code interpreter LLMs. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/kernels/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/kernels/index.mdx new file mode 100644 index 0000000000..ea36e8d5ec --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/kernels/index.mdx @@ -0,0 +1,30 @@ +--- +title: "Kernels" +--- + +You are reading a legacy (pre v1.0) document. + + +In this section you can find information about kernels and how to use them in Code Interpreter SDK. Having multiple kernels allows you to run code in separate contexts and optionally also languages. + +By default the template starts with one default kernel. This kernel is used to execute code, if you don't specify `kernelID`. You can imagine kernel as a separate environment where code is executed. You can have multiple kernels running at the same time. Each kernel has its own state, so you can have multiple kernels running different code at the same time. + +Kernel will be kept alive with the sandbox even if you disconnect. + +## Creating a new kernel + +To create a new kernel there's a `create_kernel` in Python and `createKernel()` in JavaScript/TypeScript method in the `CodeInterpreter` class. This method takes two optional arguments: +- `cwd` - working directory for the kernel, all system commands and file operations will be executed in this directory +- `kernel name` - kernel spec name (defaults to default kernel spec for server). In our case it's `python3`. If you want to use another kernel, you have to install in the template first. In that case you probably want to use [Custom Template](/legacy/code-interpreter/template). + +## Restarting a kernel + +To restart a kernel you can use `restart` method. This method takes one argument - `kernelID`, if not specifed it will restart the default kernel. This method will restart the kernel and clear its state. + +## Listing kernels + +To list all kernels you can use `list` method. This method returns an array of all running kernels with their IDs and kernel spec names. + +## Shutting down a kernel + +To shutdown a kernel you can use `shutdown` method. This method takes one argument - `kernelID`, if not specifed it will delete the default kernel. This method will delete the kernel and all its state. diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/template/index.mdx new file mode 100644 index 0000000000..d6ff68a4a5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/code-interpreter/template/index.mdx @@ -0,0 +1,61 @@ +--- +title: "Using custom sandbox template & custom compute with Code Interpreter SDK" +--- + +You are reading a legacy (pre v1.0) document. + + +# Using custom sandbox template & custom compute with Code Interpreter SDK + +If you want to customize the Code Interprerter sandbox (e.g.: add a preinstalled package) you can do that by using a [custom sandbox template](https://e2b.dev/docs/sandbox/templates/overview). + + +## Step-by-step guide +1. Create custom sandbox by following [this guide](/legacy/guide/custom-sandbox) + +2. Use prebuilt [E2B Code Interpreter image](https://hub.docker.com/r/e2bdev/code-interpreter) by replacing the `FROM` command in your `e2b.Dockerfile` with following + + ```sh + FROM e2bdev/code-interpreter:latest + ``` + +3. Run the following in the same directory where's your `e2b.toml` + ```sh + e2b template build -c "/root/.jupyter/start-up.sh" + ``` + +4. Use your custom sandbox with Code Interpreter SDK + + + ```python Python + from e2b_code_interpreter import CodeInterpreter + sandbox = CodeInterpreter(template="your-custom-sandbox-name") + execution = sandbox.notebook.exec_cell("print('hello')") + sandbox.close() + + # Or you can use `with` which handles closing the sandbox for you + with CodeInterpreter(template="your-custom-sandbox-name") as sandbox: + execution = sandbox.notebook.exec_cell("print('hello')") + ``` + + ```js JavaScript & TypeScript + import { CodeInterpreter } from '@e2b/code-interpreter' + const sandbox = await CodeInterpreter.create({ template: 'your-custom-sandbox-name' }) + const execution = await sandbox.notebook.execCell('print("hello")') + await sandbox.close() + ``` + + + +## Customize CPU & RAM of your sandbox +You can customize number of CPUs and MiB of RAM for your sandbox. To achieve that, specify the `--cpu-count` and `--memory-mb` options during the build step: +```sh +e2b template build -c "/home/user/.jupyter/start-up.sh" --cpu-count 4 --memory-mb 4096 +``` +The above will create a custom sandbox with 4 CPUs a 4 GiB of RAM. + +## How to install another Python kernels + +Jupyter has ability to work with different than Python kernel. It even supports multiple kernels in one notebook. If you want to install another kernels. + +You can find list of available kernels [here](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels). Each has a little bit different installation process, but in general you need to install kernel package and register it in jupyter. diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/examples/clone-repo/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/examples/clone-repo/index.mdx new file mode 100644 index 0000000000..6b55d9cbff --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/examples/clone-repo/index.mdx @@ -0,0 +1,7 @@ +--- +title: "Clone GitHub Repository" +--- + +You are reading a legacy (pre v1.0) document. + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-help/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-help/index.mdx new file mode 100644 index 0000000000..31ddc50828 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-help/index.mdx @@ -0,0 +1,12 @@ +--- +title: "Getting help" +--- + +You are reading a legacy (pre v1.0) document. + + +If you have any questions, issues, or feature requests, please reach out on of the following channels: +- Send us an email at [hello@e2b.dev](mailto:hello@e2b.dev) +- Talk to us on our [Discord server](https://discord.gg/U7KEcGErtQ) +- Open an issue on [our GitHub](https://github.com/e2b-dev/e2b) +- Reach out on [Twitter / X](https://x.com/e2b) \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/api-key/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/api-key/index.mdx new file mode 100644 index 0000000000..a43eb73fc6 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/api-key/index.mdx @@ -0,0 +1,32 @@ +--- +title: Use API key +--- + +You are reading a legacy (pre v1.0) document. + + +To use the API key, you either: +- **Set the API key as the `E2B_API_KEY` environment variable** +- Or pass it directly to the `CodeInterpreter` constructor like this: + + +```js JavaScript & TypeScript +import { CodeInterpreter } from '@e2b/code-interpreter' + +const sandbox = await CodeInterpreter.create({ apiKey: 'YOUR_API_KEY' }) +await sandbox.notebook.execCell('x = 1') + +const execution = await sandbox.notebook.execCell('x+=1; x') +console.log(execution.text) // outputs 2 + +await sandbox.close() +``` +```python Python +from e2b_code_interpreter import CodeInterpreter + +with CodeInterpreter(api_key="YOUR_API_KEY") as code_interpreter: + sandbox.notebook.exec_cell("x = 1") + execution = sandbox.notebook.exec_cell("x+=1; x") + print(execution.text) # outputs 2 +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/installation/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/installation/index.mdx new file mode 100644 index 0000000000..6a9be366fd --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/getting-started/installation/index.mdx @@ -0,0 +1,46 @@ +--- +title: "Installation" +--- + +You are reading a legacy (pre v1.0) document. + + +You create and control sandboxes with our SDKs. +We offer SDKs for [JavaScript / TypeScript](https://www.npmjs.com/package/e2b), and [Python](https://pypi.org/project/e2b/). + + + + Usable both in Node.js and in the browser. Requires at least Node.js 18.0. + + + Requires at least Python 3.8. + + + +You can install them using the following commands: + + +```bash JavaScript & TypeScript +npm install e2b +``` +```bash Python +pip install e2b +``` + + + +## Next steps + +1. [Get your API key](/legacy/getting-started/api-key) +1. [Explore the Sandbox API](/legacy/sandbox/api/envs) +{/* 1. [Follow the "Hello World" example](/guides/) */} +{/* 1. [Check out the official guides](/guides/overview) */} +{/* 1. [Explore integrations with AI frameworks and LLMs](/integrations/overview) */} diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-code-interpreter-language-runtimes/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-code-interpreter-language-runtimes/index.mdx new file mode 100644 index 0000000000..5b30171525 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-code-interpreter-language-runtimes/index.mdx @@ -0,0 +1,59 @@ +--- +title: "Code Interpreter SDK Beta - Language Runtimes" +--- + +You are reading a legacy (pre v1.0) document. + + +This guide shows how to run AI-generated code in different language runtimes using the new Code Interpreter beta SDK. +The following language runtimes are currently supported: +- **Python** +- **JavaScript** +- **Java** +- **Bash** +- **R** + + +Want more language runtimes? Reached out to us on [Discord](https://discord.gg/U7KEcGErtQ) or over [email](emailto:contact@e2b.dev). + + +## 1. Install the Code Interpreter beta SDK +The latest beta versions you should install can be found in NPM/PyPi release history: +- **JavaScript & TypeScript** + - [Latest release](https://www.npmjs.com/package/@e2b/code-interpreter?activeTab=versions) with *rc* tag for `@e2b/code-interpreter` +- **Python** + - [Latest release](https://pypi.org/project/e2b-code-interpreter/#history) with *PRE-RELEASE* for `e2b-code-interpreter` + + +## 2. Active kernel for the desired language +Each of the supported language runtimes has its own kernel. + + +```python Python +from e2b_code_interpreter import CodeInterpreter + +sandbox = CodeInterpreter() + +# 1. Set JS kernel - available kernel names: 'r', 'javascript', 'java', 'bash' +js_id = sandbox.notebook.create_kernel(kernel_name="javascript") +# 2. Run JS code inside code interpreter! +execution = sandbox.notebook.exec_cell("console.log('Hello World!')", kernel_id=js_id) +print(execution) +# 3. Use Python again +sandbox.notebook.exec_cell("print('Hello World!')") +``` + +```js JavaScript & TypeScript +import { CodeInterpreter } from '@e2b/code-interpreter' + +const sandbox = await CodeInterpreter.create() + +// 1. Set JS kernel - available kernel names: 'r', 'javascript', 'java', 'bash' +const jsID = await sandbox.notebook.createKernel({ kernelName: 'javascript' }) +// 2. Run JS code inside code interpreter! +const execution = await sandbox.notebook.execCell("console.log('Hello World!')", { kernelID: jsID }) +console.log(execution) +// 3. Use Python again +await sandbox.notebook.execCell('print("Hello World!")') +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-migration/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-migration/index.mdx new file mode 100644 index 0000000000..9b8fc04649 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/beta-migration/index.mdx @@ -0,0 +1,705 @@ +--- +title: "SDK Beta - Migration Guide" +--- + +You are reading a legacy (pre v1.0) document. + + +The following guide shows how to migrate your code from the current Core SDKs (`e2b`) and Code Interpreter SDKs (`@e2b/code-interpreter`/`e2b-code-interpreter`) to the beta versions. + +The latest beta versions you should install can be found in NPM/PyPi release history: +- **JavaScript & TypeScript** + - [Latest release](https://www.npmjs.com/package/e2b?activeTab=versions) with *rc* tag for `e2b` + - [Latest release](https://www.npmjs.com/package/@e2b/code-interpreter?activeTab=versions) with *rc* tag for `@e2b/code-interpreter` +- **Python** + - [Latest release](https://pypi.org/project/e2b/#history) with *PRE-RELEASE* for `e2b` + - [Latest release](https://pypi.org/project/e2b-code-interpreter/#history) with *PRE-RELEASE* for `e2b-code-interpreter` + +## Table of contents +- [Core Sandbox SDK changes](#core-sandbox-sdk-changes) + - [Creating sandbox](#creating-sandbox) + - [Modifying sandbox timeout](#modifying-sandbox-timeout) + - [Reconnecting](#reconnecting) + - [Writing files to sandbox](#writing-files-to-sandbox) + - [Reading files from sandbox](#reading-files-from-sandbox) + - [Uploading data to sandbox](#uploading-data-to-sandbox) + - [Downloading files from sandbox](#downloading-files-from-sandbox) + - [Running processes](#running-processes) + - [Watching for files' changes](#watching-for-files-changes) + - [Accessing sandbox ID](#accessing-sandbox-id) + - [Getting sandbox upload URL](#getting-sandbox-upload-url) + - [Configuring sandbox `cwd`](#configuring-sandbox-cwd) + - [Timeouts](#timeouts) + - [Listing sandboxes](#listing-sandboxes) + - [Getting sandbox url](#getting-sandbox-url) + - [Code Interpreter SDK changes](#code-interpreter-sdk-changes) + - [Executing code](#executing-code) + - [Custom template](#custom-template) + - [Python Async](#python-async) + - [Watching for files' changes in async Python SDK](#watching-for-files-changes-in-async-python-sdk) + - [Running background commands in async Python SDK](#running-background-commands-in-async-python-sdk) + + +##

    Core Sandbox SDK changes

    +These changes affect both the `e2b` Core SDKs and Code Interpreter SDKs (`@e2b/code-interpreter`/`e2b-code-interpreter`) because the Code Interpreter uses the Core SDK. + + +If you are using a custom template you need to rebuild it by calling `e2b template build` in the directory with the template. + + +## Creating sandbox + +When creating a sandbox you now **specify the sandbox timeout — how long the sandbox will exist**. If you don't specify the timeout the sandbox will be closed after 5 minutes. + +You also no longer call the `.close()` method when you are done with the sandbox. Sandbox will be automatically closed and killed after the timeout. + +You can use `.kill()` to kill the sandbox immediately if you are sure you won't need it anymore. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandbox = await Sandbox.create() +// await sandbox.close() + +// Now +const sandbox = await Sandbox.create({ timeoutMs: 300_000 }) +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox = Sandbox.create() +# sandbox.close() + +# Now +sandbox = Sandbox.create(timeout=300) +``` + + +If you need to use a [custom sandbox template](/legacy/guide/custom-sandbox) you pass the template as the first parameter: + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandbox = await Sandbox.create({ template: 'template-name-or-id' }) +// await sandbox.close() + +// Now +const sandbox = await Sandbox.create('template-name-or-id', { + timeoutMs: 300_000, +}) +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox = Sandbox.create(template='template-name-or-id') +# sandbox.close() + +# Now +sandbox = Sandbox.create(template='template-name-or-id', timeout=300) +``` + + +## Modifying sandbox timeout +If you need to change how long the sandbox should stay alive after it was created, you can use `.setTimeout()`/`.set_timeout()` method. +It will modify the timeout of the sandbox. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandbox = await Sandbox.create() +// await sandbox.keepAlive(600_000) + +// Now +const sandbox = await Sandbox.create({ timeoutMs: 300_000 }) +await sandbox.setTimeout(600_000) +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox = Sandbox.create() +# sandbox.keep_alive(600) + +# Now +sandbox = Sandbox.create(timeout=300) +sandbox.set_timeout(600) +``` + + +## Reconnecting +When connection to an existing sandbox use `.connect()`/`.connect()` method instead of `.reconnect()`/`.reconnect()`. + +Instead of using `.keepAlive()`/`.keep_alive()` method to prevent the sandbox from closing until you reconnect use `.setTimeout()`/`.set_timeout()` method. +Because the timeout is set when the sandbox is created, you may not need to set the timeout when reconnecting at all now. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandbox = await Sandbox.create() +// await sandbox.keepAlive(600_000) +// await sandbox.close() + +// const existingSandbox = await Sandbox.reconnect(sandbox.id) + +// Now +const sandbox = await Sandbox.create({ timeoutMs: 600_000 }) + +const existingSandbox = await Sandbox.connect(sandbox.sandboxId) +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox = Sandbox.create() +# sandbox.keep_alive(600) +# sandbox.close() + +# existing_sandbox = Sandbox.reconnect(sandbox.id) + +# Now +sandbox = Sandbox.create(timeout=600) + +existing_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +## Writing files to sandbox +Use `.files.write()` method to write files to the sandbox. + +The method accepts `path` in the sandbox as the first argument and the `data` as the second argument. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// await sandbox.filesystem.write('/hello.txt', 'Hello World!') + +// Now +await sandbox.files.write('/path/in/sandbox', 'Hello World!') +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox.filesystem.write("/hello.txt", "Hello World!") + +# Now +sandbox.files.write("/path/in/sandbox", "Hello World!") +``` + + +## Reading files from sandbox +Use `.files.read()` method to read files from the sandbox. + +The method accepts `path` in the sandbox as the first argument and optional `format` as the second argument. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +//const content = await sandbox.downloadFile('/path/in/sandbox') + +// Now +const content = await sandbox.files.read('/path/in/sandbox') +``` +```python Python +from e2b import Sandbox + +# Before +# content = sandbox.download_file("/path/in/sandbox") + +# Now +content = sandbox.files.read("/path/in/sandbox") +``` + + +## Uploading data to sandbox +Use `.files.write()` method to upload files to the sandbox. + +The method accepts `path` in the sandbox as the first argument and the `data` as the second argument. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const content = fs.readFileSync('/local/path') +// await sandbox.uploadFile(content, '/path/in/sandbox') + +// Now +const content = fs.readFileSync('/local/path') +await sandbox.files.write('/path/in/sandbox', content) +``` +```python Python +from e2b import Sandbox + +# Before +# with open("path/to/local/file", "rb") as file: +# sandbox.upload_file(file) + +# Now +with open("path/to/local/file", "rb") as file: + sandbox.files.write("/path/in/sandbox", file) +``` + + +## Downloading files from sandbox +Use `.files.read()` method to download files from the sandbox. + +The method accepts `path` in the sandbox as the first argument and optional `format` as the second argument. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +//const content = await sandbox.downloadFile('/path/in/sandbox') + +// Now +const content = await sandbox.files.read('/path/in/sandbox') +``` +```python Python +from e2b import Sandbox + +# Before +# content = sandbox.download_file("/path/in/sandbox") + +# Now +content = sandbox.files.read("/path/in/sandbox") +``` + + + +## Running processes +You execute processes by calling `.commands.run()` method. By default, the method waits for the command to finish. + +You can specify the timeout for the command execution by passing `timeoutMs`/`timeout` option. The default timeout is 60 seconds. + +If the command fails with a non-zero exit it will raise `CommandExitError` in Javascript, or `CommandExitException` in Python, and you can catch and inspect the error for more info. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandbox = await Sandbox.create() +// const result = await sandbox.process.startAndWait({ +// cmd: 'echo "Hello, world!"', +// onStderr: (msg) => console.log(msg.line), +// onStdout: (msg) => console.log(msg.line), +// }) + +// Now +const result = await sandbox.commands.run('echo "Hello, World!"', { + onStderr(output) { console.log(output) }, + onStdout(output) { console.log(output) }, + timeoutMs: 60_000, +}) +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox = Sandbox.create() +# result = sandbox.process.start_and_wait( +# cmd='echo "Hello, world!"', +# on_stderr=lambda msg: print(msg.line), +# on_stdout=lambda msg: print(msg.line), +# ) + +# Now +result = sandbox.commands.run( + cmd='echo "Hello, World!"', + timeout=60, + on_stdout=lambda output: print(output), + on_stderr=lambda output: print(output), +) +``` + +If you want to run the command in the background use `background: true`/`background=True` option. +You can then use `.wait()` method to wait for the command to finish. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandbox = await Sandbox.create() +// const process = await sandbox.process.start({ +// cmd: 'sleep 10; echo "Hello, world!"', +// onStderr: (msg) => console.log(msg.line), +// onStdout: (msg) => console.log(msg.line), +// }) + +// const result = await process.wait() + +// Now +const command = await sandbox.commands.run('sleep 10; echo "Hello, world!"', { + onStderr(output) { console.log(output) }, + onStdout(output) { console.log(output) }, + background: true, +}) + +const result = await command.wait() +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox = Sandbox.create() +# process = sandbox.process.start( +# cmd='echo "Hello, world!"', +# on_stderr=lambda msg: print(msg.line), +# on_stdout=lambda msg: print(msg.line), +# ) + +# result = process.wait() + +# Now +command = sandbox.commands.run( + cmd='echo "Hello, World!"', + background=True, +) + +result = command.wait( + on_stderr=lambda output: print(output), + on_stdout=lambda output: print(output), +) +``` + + + +## Watching for files' changes + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandbox = await Sandbox.create() +// const watcher = sandbox.filesystem.watchDir('/path/in/sandbox') +// watcher.addEventListener((event) => console.log(event)) +// await watcher.start() + +// Now +const sandbox = await Sandbox.create() +await sandbox.files.watchDir('/path/in/sandbox', (event) => console.log(event)) +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox = Sandbox.create() + +# watcher = sandbox.filesystem.watch_dir("/path/in/sandbox") +# watcher.add_event_listener(lambda event: print(event)) +# watcher.start() + +# Now +sandbox = Sandbox.create() +watcher = sandbox.files.watch_dir("/path/in/sandbox") + +for event in watcher: + print(event) +``` + + +## Accessing sandbox ID +The `id` property on the sandbox/code interpreter instance is now named `sandboxId`/`sandbox_id`. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandboxId = await sandbox.id + +// Now +const sandboxId = await sandbox.sandboxId +``` +```python Python +from e2b import Sandbox + +# Before +# sandbox_id = sandbox.id + +# Now +sandbox_id = sandbox.sandbox_id +``` + + +## Getting sandbox upload URL +The `.fileURL`/`.file_url()` is now `.uploadURL`/`.upload_url()` method that takes an optional argument that specifies the path in the sandbox where the file will be uploaded. + +If the path is not specified the file will be uploaded to the home dir — `/home/user`. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const url = await sandbox.fileURL + +// Now +const url = await sandbox.uploadUrl('/path/in/sandbox') +``` +```python Python +from e2b import Sandbox + +# Before +# url = sandbox.file_url() + +# Now +url = sandbox.upload_url('/path/in/sandbox') +``` + + +## Configuring sandbox `cwd` +Previously you could set the sandbox working directory by passing `cwd` option when creating the sandbox. +Right now this is not supported because it leads to subtle bugs especially when reconnecting to an existing sandbox. + +If you need this feature please reach out to us on [Discord](https://discord.com/invite/U7KEcGErtQ) or [GitHub](https://github.com/e2b-dev/e2b) so we can prioritize it. + +## Timeouts +There are now two types of timeouts that you can pass as parameters: +1. `request_timeout`/`requestTimeoutMs` sets how long the operation should wait for connection/processing. +This is useful for ensuring that none of the sandbox operations hang indefinitely. +2. `timeout`/`timeoutMs` which is used for setting the maximum length of long-running operations like executing code, running processes, or the sandbox itself. + +## Listing sandboxes +Some properties returned from the `Sandbox.list` method have been renamed. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const sandboxes = await Sandbox.list() + +// `sandboxes` is an array of `RunningSandbox` objects: +// { +// sandboxID: string +// templateID: string +// alias?: string +// metadata?: SandboxMetadata +// startedAt: Date +// } + +// Now +const sandboxes = await Sandbox.list() + +// `sandboxes` is an array of `SandboxInfo` objects: +// { +// sandboxId: string +// templateId: string +// name?: string +// metadata: Record +// startedAt: Date +// } +``` +```python Python +from e2b import Sandbox + +# Before +# sandboxes = Sandbox.list() + +# `sandboxes` is an array of `RunningSandbox` objects: +# class RunningSandbox(BaseModel): +# sandbox_id: str +# template_id: str +# alias: Optional[str] +# metadata: Optional[Dict[str, str]] +# cpu_count: int +# memory_mb: int +# started_at: datetime + +# Now +sandboxes = Sandbox.list() + +# `sandboxes` is an array of `SandboxInfo` objects: +# @dataclass +# class SandboxInfo: +# sandbox_id: str +# template_id: str +# name: Optional[str] +# metadata: Dict[str, str] +# started_at: datetime + +``` + + + +## Getting sandbox url +The method for getting the sandbox host has changed from `sandbox.getHostname/sandbox.get_hostname` to `sandbox.getHost/sandbox.get_host`. +It now requires specifying the port. + + +```js JavaScript & TypeScript +import Sandbox from 'e2b' + +// Before +// const host = await sandbox.getHostname(80) + +// Now +const host = await sandbox.getHost(80) +``` +```python Python +from e2b import Sandbox + +# Before +# host = sandbox.get_hostname(80) + +# Now +host = sandbox.get_host(80) +``` + + + +##

    Code Interpreter SDK changes

    +All the previously mentioned changes to the Core SDK also apply to the Code Interpreter SDK. +Apart from them, the changes to the Code Interpreter SDK are very minimal: + +## Executing code +When executing code via JS/TS Code Interpreter SDK you now pass the `timeoutMs` option to the `execCell` method instead of `timeout`. + +The default timeout for the code execution is now 300 seconds. + + +```js JavaScript & TypeScript +import CodeInterpreter from '@e2b/code-interpreter' + +// Before +// const sandbox = await CodeInterpreter.create() +// const execution = await sandbox.notebook.execCell('print("Hello, world!")', { +// timeout: 2000, +// }) +// await sandbox.close() + +// Now +const sandbox = await CodeInterpreter.create({ timeoutMs: 300_000 }) +const execution = await sandbox.notebook.execCell('print("Hello, world!")', { + timeoutMs: 2000, +}) +``` + +```python Python +from e2b_code_interpreter import CodeInterpreter + +# Before +# sandbox = CodeInterpreter() +# execution = sandbox.notebook.exec_cell('print("Hello, world!")', timeout=2) +# sandbox.close() + +# Now +sandbox = CodeInterpreter(timeout=300) +execution = sandbox.notebook.exec_cell('print("Hello, world!")', timeout=2) +``` + + +## Custom template +If you are using a custom template for the Code Interpreter you need to rebuild it. + + +You can rebuild the template by either calling +```sh +e2b template build -c "/root/.jupyter/start-up.sh" +``` +if you use the E2B Docker image as base in your `e2b.Dockerfile` +```docker +FROM e2bdev/code-interpreter:latest + +# You custom Dockerfile content here +``` + +Or if you are using custom base you need to copy all files excluding the `e2b.toml` from [beta template](https://github.com/e2b-dev/legacy/code-interpreter/tree/beta/template) +to the directory with your template and then run `e2b template build -c "/root/.jupyter/start-up.sh"`. + + +Check of the [Code Interpreter custom template](/legacy/code-interpreter/template) page for more info. + + +##

    Python Async

    +Python Core SDK and Code Interpter SDK now support async. + +If you need to use async import `AsyncSandbox`/`AsyncCodeInterpreter` instead of `Sandbox`/`CodeInterpreter`. + + +```python Python +# Sync +# from e2b import Sandbox +# sandbox = Sandbox.create() + +# from e2b_code_interpreter import CodeInterpreter +# sandbox = CodeInterpreter() + +# Async +from e2b import AsyncSandbox +from e2b_code_interpreter import AsyncCodeInterpreter + +sandbox = await AsyncSandbox.create() +sandbox = await AsyncCodeInterpreter.create() +``` + + +The async versions of methods for watching for files' changes and running commands in the background are slightly different: + +## Watching for files' changes in async Python SDK + + +```python Python +from e2b import Sandbox + +# Sync +# sandbox = Sandbox.create() +# watcher = sandbox.files.watch_dir("/path/in/sandbox") + +# for event in watcher: +# print(event) + +# Async +sandbox = await AsyncSandbox.create() + +await sandbox.files.watch_dir("/path/in/sandbox", lambda event: print(event)) +``` + + +## Running background commands in async Python SDK + +```python Python +from e2b import Sandbox + +# Sync +# sandbox = Sandbox.create() +# command = sandbox.commands.run( +# cmd='echo "Hello, World!"', +# background=True, +# ) + +# result = command.wait( +# on_stderr=lambda output: print(output), +# on_stdout=lambda output: print(output), +# ) + +# Async +sandbox = await AsyncSandbox.create() +command = await sandbox.commands.run( + cmd='echo "Hello, World!"', + on_stderr=lambda output: print(output), + on_stdout=lambda output: print(output), + background=True, +) + +result = await command.wait() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx new file mode 100644 index 0000000000..eb342414ec --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx @@ -0,0 +1,199 @@ +--- +title: "Creating Custom Sandbox" +--- + +You are reading a legacy (pre v1.0) document. + + +In this guide, we'll create a custom E2B sandbox with preinstalled dependencies and files. +Once the sandbox is built, we'll show how to create and control it with our SDK. + +## Prerequisites +1. [Node.js](https://nodejs.org/) 18.0.0 or later +1. [E2B CLI](/legacy/cli/installation) +1. Running Docker instance + +## 1. Install E2B CLI + + +```bash Install CLI +npm install -g @e2b/cli@latest +``` + + + +You need Node.js 18.0.0 or later to install the CLI. + + +## 2. Login to CLI +Before you create your first custom sandbox, you will need to authenticate in the CLI with your E2B account. +Run the following command in your terminal. + +```bash Login to CLI +e2b auth login +``` + + + +You need to have an existing E2B account to login. Sign up [here](/legacy/getting-started/api-key). + + +## 3. Create `e2b.Dockerfile` +To describe how your custom sandbox will look like, create a new Dockerfile and name it `e2b.Dockerfile`. +We use this Dockerfile as the [template file](/legacy/sandbox/templates/template-file). + + +Run `e2b template init` to create `e2b.Dockerfile` in the current directory. + + +We want our custom sandbox to have the [ffmpeg](https://www.ffmpeg.org/) isntalled - ffmpeg is a tool for editing video and audio files. + + +We support only Debian based images at the moment. + + + +```Dockerfile e2b.Dockerfile +# You can use most of the Debian based images +FROM ubuntu:22.04 + +# Install the ffmpeg tool/ +RUN apt update \ + && apt install -y ffmpeg +``` + + +## 4. Build custom sandbox +Now it's time to create your custom sandbox based on the sandbox template file (the `e2b.Dockefile` file) you just created in the previous step. + +Run the following command inside the template file directory in your terminal. + +[Pro users](/legacy/pricing) can use the `--cpu-count=` ([docs](/legacy/cli/commands#template-build)) and `--memory-mb=` ([docs](/legacy/cli/commands#template-build)) flags to customize the sandbox compute. +Read more about the compute [here](/legacy/sandbox/compute). + + + +```bash Build sandbox template +e2b template build --name "my-agent-sandbox" +``` + + + +Use the `.dockerignore` file to exclude files from the sandbox template. + + +The final output should look similar to this. + + +```bash Build output +Preparing sandbox template building (1 files in Docker build context). +Found ./e2b.Dockerfile that will be used to build the sandbox template. +Started building the sandbox template my-agent-sandbox + +# Truncated for visibility +# ... +# ... + +Running postprocessing. It can take up to few minutes. + +Postprocessing finished. + +✅ Building sandbox template my-agent-sandbox finished. + +┌ Usage examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│ │ +│ You can use E2B Python or JS SDK to spawn sandboxes now. │ +│ Find more here - https://e2b.dev/docs/legacy/guide/custom-sandbox in Spawn and control your sandbox section. │ +│ │ +│───────────────────────────────────────────────────────────────────── Python SDK ─────────────────────────────────────────────────────────────────────│ +│ │ +│ from e2b import Sandbox │ +│ │ +│ # Start sandbox │ +│ sandbox = Sandbox.create("my-agent-sandbox") │ +│ │ +│ # Interact with sandbox. Learn more here: │ +│ # https://e2b.dev/docs/sandbox/overview │ +│ │ +│ # Close sandbox once done │ +│ sandbox.close() │ +│ │ +│─────────────────────────────────────────────────────────────────────── JS SDK ───────────────────────────────────────────────────────────────────────│ +│ │ +│ import { Sandbox } from 'e2b' │ +│ │ +│ // Start sandbox │ +│ const sandbox = await Sandbox.create('my-agent-sandbox') │ +│ │ +│ // Interact with sandbox. Learn more here: │ +│ // https://e2b.dev/docs/sandbox/overview │ +│ │ +│ // Close sandbox once done │ +│ await sandbox.close() │ +│ │ +└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ + +Execution time: 42.55s +``` + + + +This will create the `e2b.toml` file storing the sandbox config. + +```toml e2b.toml +# This is a config for E2B sandbox template +template_id = "1wdqsf9le9gk21ztb4mo" +dockerfile = "e2b.Dockerfile" +template_name = "my-agent-sandbox" +``` + + +| Sandbox template name | Sandbox template ID | +---|---| +|`my-agent-sandbox`|`1wdqsf9le9gk21ztb4mo`| + +### Updating your sandbox template +If you want to update your sandbox template, you run the same command you did to build it. +This will rebuild the template. + + +```bash Update sandbox template +e2b template build +``` + + +## 5. Spawn and control your sandbox + +Now you can use the [E2B SDK](/legacy/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 `template` parameter. +This way, we'll be able to spawn our custom sandbox and control it with the SDK. + +##### Spawn & control your custom sandbox + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +// Spawn your custom sandbox +const sandbox = await Sandbox.create({ template: 'my-agent-sandbox' }) // $HighlightLine + +// Interact with sandbox. Learn more here: +// https://e2b.dev/docs/sandbox/overview + +// Close sandbox once done +await sandbox.close() +``` + +```python Python +from e2b import Sandbox + +# Spawn your custom sandbox +sandbox = Sandbox.create(template="my-agent-sandbox") # $HighlightLine + +# Interact with sandbox. Learn more here: +# https://e2b.dev/docs/sandbox/overview + +# Close sandbox once done +sandbox.close() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/js/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/js/index.mdx new file mode 100644 index 0000000000..5c567e9ac5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/js/index.mdx @@ -0,0 +1,308 @@ +--- +title: "Hello World.ts" +--- + +You are reading a legacy (pre v1.0) document. + + +This JavaScript guide will show you the basics of E2B: +- Connect the code interpreter to an LLM +- Prompt the LLM to generate the Python code +- Execute the AI-generated Python code in a secure E2B sandbox + +### Get full code +Check out the [full code in our cookbook](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/hello-world-js). + +### Overview +1. [Install Code Interpreter SDK](#1-install-code-interpreter-sdk) +1. [Prepare prompt and tools for LLM](#2-prepare-prompt-and-tools-for-llm) +1. [Prepare code interpreting](#3-prepare-code-interpreting) +1. [Call LLM and parse response with tools](#4-call-llm-and-parse-response-with-tools) +1. [Create code interpreter and run everything](##5-create-code-interpreter-and-run-everything) +1. [Save generated chart](#6-save-generated-chart) + + +## 1. Install Code Interpreter SDK + +The Code Interpreter SDK allows you to run AI-generated code in a secure small VM - **E2B sandbox** - made for AI code execution. +Inside the sandbox is a Jupyter server running that you can control from our SDK through the `notebook.execCell()` method. + +Check out the [SDK's repository on GitHub](https://github.com/e2b-dev/code-interpreter). + + +```bash JavaScript & TypeScript +npm init -y \ +&& npm i --save-dev typescript tsx @types/node \ +&& npm i @e2b/code-interpreter +``` + + +Get your E2B API key [here](/legacy/getting-started/api-key) and save it to `.env` in your root directory. + +```bash .env +E2B_API_KEY="e2b-api-key" +``` + + +## 2. Prepare prompt and tools for LLM +We'll be using Anthropic's [Claude 3 Opus](https://www.anthropic.com/news/claude-3-family) model but E2B works with any LLM so feel free to pick any you want! + + +Usually, all you need from the model is just support for tool use. If the LLM doesn't support tool use, you can ask the LLM to respond with Markdown or XML and parse the LLM's output on your own. Then just pass the parsed code from code blocks to the code interpreter. + + +Create the `model.ts` file and paste the following code. + +```ts model.ts +import { Anthropic } from '@anthropic-ai/sdk' + +export const MODEL_NAME = 'claude-3-opus-20240229' + +export const SYSTEM_PROMPT = ` +## your job & context +you are a python data scientist. you are given tasks to complete and you run python code to solve them. +- the python code runs in jupyter notebook. +- every time you call \`execute_python\` tool, the python code is executed in a separate cell. it's okay to multiple calls to \`execute_python\`. +- display visualizations using matplotlib or any other visualization library directly in the notebook. don't worry about saving the visualizations to a file. +- you have access to the internet and can make api requests. +- you also have access to the filesystem and can read/write files. +- you can install any pip package (if it exists) if you need to but the usual packages for data analysis are already preinstalled. +- you can run any python code you want, everything is running in a secure sandbox environment. +` + +export const tools: Anthropic.Tool[] = [ + { + name: 'execute_python', + description: 'Execute python code in a Jupyter notebook cell and returns any result, stdout, stderr, display_data, and error.', + input_schema: { + type: 'object', + properties: { + code: { + type: 'string', + description: 'The python code to execute in a single cell.' + } + }, + required: ['code'] + } + } +] + +``` + + +This defines our system prompt and the `tools` dictionary with available tools for the LLM - namely the `"execute_python"` tool. +A little bit later, we'll connect `"execute_python"` to the E2B's code interpretrer. + + +## 3. Prepare code interpreting +We'll create a new function called `codeInterpret()` in a separate file `codeInterpreter.ts`. + + +```ts codeInterpreter.ts +import { CodeInterpreter } from '@e2b/code-interpreter' + +export async function codeInterpret(codeInterpreter: CodeInterpreter, code: string) { + console.log(`\n${'='.repeat(50)}\n> Running following AI-generated code:\n${code}\n${'='.repeat(50)}`); + + const exec = await codeInterpreter.notebook.execCell( + code, + { + // You can stream logs from the code interpreter + // onStderr: (stderr: string) => console.log("\n[Code Interpreter stdout]", stderr), + // onStdout: (stdout: string) => console.log("\n[Code Interpreter stderr]", stdout), + // + // You can also stream additional results like charts, images, etc. + // onResult: ... + } + ) + + if (exec.error) { + console.log('[Code Interpreter error]', exec.error) // Runtime error + return undefined + } + + return exec +} +``` + + +This function takes the `CodeInterpreter` object from our SDK, and `code` as paramaters. +The `code` parameter is the code generated by the LLM. + +Inside the function, we call the `codeInterpreter.notebook.execCell()` method. The `execCell()` takes `code` argument, and executes this `code` inside E2B sandbox. + +## 4. Call LLM and parse response with tools +We're using Claude 3 Opus. Get your [Anthropic API key](https://console.anthropic.com/), save it to `.env` file, and install the [Anthropic SDK](https://docs.anthropic.com/claude/reference/client-sdks). + + +```bash .env +ANTHROPIC_API_KEY="anthropic-api-key" +``` + + + +```bash npm +npm i @anthropic-ai/sdk@0.28.0 +``` + + +Now we'll put everything together. +Create the `index.ts` file, import dependencies, and create the `chat()` function that will do the LLM calling and tool parsing. + + +```ts index.ts +import * as fs from 'fs' + +import 'dotenv/config' +import { CodeInterpreter, Execution } from '@e2b/code-interpreter' +import Anthropic from '@anthropic-ai/sdk' + +import { + MODEL_NAME, + SYSTEM_PROMPT, + tools, +} from './model' +import { codeInterpret } from './codeInterpreter' + +const anthropic = new Anthropic() + +async function chat(codeInterpreter: CodeInterpreter, userMessage: string): Promise { + console.log('Waiting for Claude...') + + const msg = await anthropic.messages.create({ + model: MODEL_NAME, + system: SYSTEM_PROMPT, + max_tokens: 4096, + messages: [{role: 'user', content: userMessage}], + tools, + }) + + console.log(`\n${'='.repeat(50)}\nModel response: ${msg.content}\n${'='.repeat(50)}`) + console.log(msg) + + if (msg.stop_reason === 'tool_use') { + const toolBlock = msg.content.find((block) => block.type === 'tool_use'); + const toolName = toolBlock.name + const toolInput = toolBlock.input + + console.log(`\n${'='.repeat(50)}\nUsing tool: ${toolName}\n${'='.repeat(50)}`); + + if (toolName === 'execute_python') { + const code = toolInput.code + return codeInterpret(codeInterpreter, code) + } + return undefined + } +} +``` + + +## 5. Create code interpreter and run everything +Now we put all together, and run our program. In the end of `index.ts` add following code prompting the LLM to visualize a distribution of height of men and print the median. + + +```ts index.ts +async function run() { + const userMessage = 'Visualize a distribution of height of men based on the latest data you know. Also print the median value.' + + const codeInterpreter = await CodeInterpreter.create() + + const codeOutput = await chat(codeInterpreter, userMessage) + if (!codeOutput) { + console.log('No code output') + return + } + + const logs = codeOutput.logs + console.log(logs) + + if (codeOutput.results.length == 0) { + console.log('No results') + return + } + + const firstResult = codeOutput.results[0] + // Print description of the first rich result + console.log(firstResult.text) + + await codeInterpreter.close() +} + +run() +``` + + +After running your code with the following command + +```bash bash +$ tsx index.ts +``` + + +you should see similar results to this: + +```sh +stdout=['The median male height is 175.5 cm\n'] stderr=[] +
    +``` + +We got our median in the logs (`stdout`, and `stderr`) but we also something intering in `firstResult`. +```sh +
    +``` + +## 6. Save generated chart + +This looks like a plot. Let's save it to a file. Update the `run()` function like this, +and run the code again with `tsx index.ts` in your terminal. + +```ts index.ts +async function run() { + const userMessage = 'Visualize a distribution of height of men based on the latest data you know. Also print the median value.' + + const codeInterpreter = await CodeInterpreter.create() + + const codeOutput = await chat(codeInterpreter, userMessage) + if (!codeOutput) { + console.log('No code output') + return + } + + const logs = codeOutput.logs + console.log(logs) + + if (codeOutput.results.length == 0) { + console.log('No results') + return + } + + const firstResult = codeOutput.results[0] + // Print description of the first rich result + console.log(firstResult.text) + + // If we received a chart in PNG form, we can visualize it + if (firstResult.png) { + // Decode the base64 encoded PNG data + const pngData = Buffer.from(firstResult.png, 'base64'); + + // Generate a unique filename for the PNG + const filename = 'chart.png'; + + // Save the decoded PNG data to a file + fs.writeFileSync(filename, pngData); + + console.log(`Saved chart to ${filename}`); + } + + await codeInterpreter.close() +} + +run() +``` + + +The chart got saved in the `chart.png` file and it should look similar to this: + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx new file mode 100644 index 0000000000..f52dbac5f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx @@ -0,0 +1,252 @@ +--- +title: "Hello World.py" +--- + +You are reading a legacy (pre v1.0) document. + + +This Python guide will show you the basics of E2B: +- Connect the code interpreter to an LLM +- Prompt the LLM to generate the Python code +- Execute the AI-generated Python code in a secure E2B sandbox + +### Get full code +Check out the [full code in our cookbook](https://github.com/e2b-dev/e2b-cookbook/tree/main/examples/hello-world-python). + +### Overview +1. [Install Code Interpreter SDK](#1-install-code-interpreter-sdk) +1. [Prepare prompt and tools for LLM](#2-prepare-prompt-and-tools-for-llm) +1. [Prepare code interpreting](#3-prepare-code-interpreting) +1. [Call LLM and parse response with tools](#4-call-llm-and-parse-response-with-tools) +1. [Create code interpreter and run everything](##5-create-code-interpreter-and-run-everything) +1. [Save generated chart](#6-save-generated-chart) + + +## 1. Install Code Interpreter SDK + +The Code Interpreter SDK allows you to run AI-generated code in a secure small VM - **E2B sandbox** - made for AI code execution. +Inside the sandbox is a Jupyter server running that you can control from our SDK through the `notebook.execCell()` method. + +Check out the [SDK's repository on GitHub](https://github.com/e2b-dev/code-interpreter). + + +```bash Python +pip install e2b_code_interpreter python-dotenv +``` + + +Get your E2B API key [here](/legacy/getting-started/api-key) and save it to `.env` in your root directory. + +```bash .env +E2B_API_KEY="e2b-api-key" +``` + + + +## 2. Prepare prompt and tools for LLM +We'll be using Anthropic's [Claude 3 Opus](https://www.anthropic.com/news/claude-3-family) model but E2B works with any LLM so feel free to pick any you want! + + +Usually, all you need from the model is just support for tool use. If the LLM doesn't support tool use, you can ask the LLM to respond with Markdown or XML and parse the LLM's output on your own. Then just pass the parsed code from code blocks to the code interpreter. + + +Create the `model.py` file and paste the following code. + +```python model.py +MODEL_NAME = "claude-3-opus-20240229" + +SYSTEM_PROMPT = """ +## your job & context +you are a python data scientist. you are given tasks to complete and you run python code to solve them. +- the python code runs in jupyter notebook. +- every time you call `execute_python` tool, the python code is executed in a separate cell. it's okay to multiple calls to `execute_python`. +- display visualizations using matplotlib or any other visualization library directly in the notebook. don't worry about saving the visualizations to a file. +- you have access to the internet and can make api requests. +- you also have access to the filesystem and can read/write files. +- you can install any pip package (if it exists) if you need to but the usual packages for data analysis are already preinstalled. +- you can run any python code you want, everything is running in a secure sandbox environment. +""" + +tools = [ + { + "name": "execute_python", + "description": "Execute python code in a Jupyter notebook cell and returns any result, stdout, stderr, display_data, and error.", + "input_schema": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The python code to execute in a single cell." + } + }, + "required": ["code"] + } + } +] +``` + + +This defines our system prompt and the `tools` dictionary with available tools for the LLM - namely the `"execute_python"` tool. +A little bit later, we'll connect `"execute_python"` to the E2B's code interpreter. + + +## 3. Prepare code interpreting +We'll create a new function called `code_interpret()` in a separate file `code_interpreter.py`. + + +```python code_interpreter.py +from e2b_code_interpreter import CodeInterpreter + +def code_interpret(code_interpreter: CodeInterpreter, code: str): + print(f"\n{'='*50}\n> Running following AI-generated code:\n{code}\n{'='*50}") + exec = code_interpreter.notebook.exec_cell( + code, + # You can stream logs from the code interpreter + # on_stderr=lambda stderr: print("\n[Code Interpreter stdout]", stderr), + # on_stdout=lambda stdout: print("\n[Code Interpreter stderr]", stdout), + # + # You can also stream additional results like charts, images, etc. + # on_result=... + ) + + if exec.error: + print("[Code Interpreter error]", exec.error) # Runtime error + else: + return exec.results, exec.logs +``` + + +This function takes the `CodeInterpreter` object from our SDK and `code` as paramaters. +The `code` parameter is the code generated by the LLM. + +Inside the function, we call the `code_interpreter.notebook.exec_cell()` method. The `exec_cell()` takes the `code` argument and executes this `code` inside E2B sandbox. + +## 4. Call LLM and parse response with tools +We're using Claude 3 Opus. Get your [Anthropic API key](https://console.anthropic.com/), save it to `.env` file, and install the [Anthropic SDK](https://docs.anthropic.com/claude/reference/client-sdks). + + +```bash .env +ANTHROPIC_API_KEY="anthropic-api-key" +``` + + + +```bash bash +pip install anthropic==0.35.0 +``` + + +Now we'll put everything together. +Create the `main.py` file, import dependencies, and create the `chat()` function that will do the LLM calling and tool parsing. + + +```python Python +import base64 +from dotenv import load_dotenv +from anthropic import Anthropic +from typing import List, Tuple +from e2b_code_interpreter import CodeInterpreter, Result +from e2b_code_interpreter.models import Logs + +from e2b_hello_world.model import MODEL_NAME, SYSTEM_PROMPT, tools +from e2b_hello_world.code_interpreter import code_interpret + +# Load the .env file +load_dotenv() + +client = Anthropic() + +def chat(code_interpreter: CodeInterpreter, user_message: str) -> Tuple[List[Result], Logs]: + print(f"\n{'='*50}\nUser Message: {user_message}\n{'='*50}") + + message = client.messages.create( + model=MODEL_NAME, + system=SYSTEM_PROMPT, + max_tokens=4096, + messages=[{"role": "user", "content": user_message}], + tools=tools, + ) + + print(f"\n{'='*50}\nModel response: {message.content}\n{'='*50}") + + if message.stop_reason == "tool_use": + tool_use = next(block for block in message.content if block.type == "tool_use") + tool_name = tool_use.name + tool_input = tool_use.input + + print(f"\n{'='*50}\nUsing tool: {tool_name}\n{'='*50}") + + if tool_name == "execute_python": + return code_interpret(code_interpreter, tool_input["code"]) + return [] +``` + + + +## 5. Create code interpreter and run everything +Now we are ready to run our program. At the end of `main.py` add the following code prompting the LLM to visualize a distribution of the height of men and print the median. + + +```python main.py +def main(): + user_message = "Visualize a distribution of height of men based on the latest data you know. Also, print the median value." + + # Create the CodeInterpreter object and save it as code_interpreter + with CodeInterpreter() as code_interpreter: + code_interpreter_results, code_interpreter_logs = chat( + code_interpreter, + user_message, + ) + + print(code_interpreter_logs) + + first_result= code_interpreter_results[0] + print(first_result) +``` + + +After running your code with the following command + +```bash bash +$ python main.py +``` + + +you should see results similar to this: + +```sh +stdout=['The median male height is 175.5 cm\n'] stderr=[] +
    +``` + +We got our median in the logs (`stdout`, and `stderr`) but we also something intering in `first_result`. +```sh +
    +``` + +## 6. Save generated chart + +This looks like a plot. Let's save it to a file. Add the following to the end of `main.py` and run the code again with `python main.py` in your terminal. + +```python main.py + # If we received a chart in PNG form, we can visualize it + if first_result.png: + # Decode the base64 encoded PNG data + png_data = base64.b64decode(first_result.png) + + # Generate a unique filename for the PNG + filename = f"chart.png" + + # Save the decoded PNG data to a file + with open(filename, "wb") as f: + f.write(png_data) + + print(f"Saved chart to {filename}") +``` + + +The chart was saved in the `chart.png` file and it should look similar to this: + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/index.mdx new file mode 100644 index 0000000000..9b1f174f18 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/index.mdx @@ -0,0 +1,53 @@ +--- +title: "Code interpreting for your AI app" +--- + +You are reading a legacy (pre v1.0) document. + +E2B's [Code Interpreter SDK](https://github.com/e2b-dev/code-interpreter) allows you to add code interpreting capabilities to your AI apps. + +With code interpreting, you can build apps like: +- AI code execution +- Data analysis with AI +- AI tutors +- Reasoning modules for LLM + +## Quickstart + +### 1. Install SDK + +```bash JavaScript & TypeScript +npm i @e2b/code-interpreter +``` +```bash Python +pip install e2b_code_interpreter +``` + + +### 2. Execute code with code interpreter inside sandbox + +```ts JavaScript & TypeScript +import { CodeInterpreter } from '@e2b/code-interpreter' + +const sandbox = await CodeInterpreter.create() +await sandbox.notebook.execCell('x = 1') + +const execution = await sandbox.notebook.execCell('x+=1; x') +console.log(execution.text) // outputs 2 + +await sandbox.close() +``` + +```py Python +from e2b_code_interpreter import CodeInterpreter + +with CodeInterpreter() as sandbox: + sandbox.notebook.exec_cell("x = 1") + + execution = sandbox.notebook.exec_cell("x+=1; x") + print(execution.text) # outputs 2 +``` + + +### 3. Hello World guide +Dive depeer and check out the [JavaScript](/legacy/hello-world/js) and [Python](/legacy/hello-world/py) Hello World guides to learn how to connect the code interpreter to LLMs. diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/open-source/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/open-source/index.mdx new file mode 100644 index 0000000000..1b13cf322f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/open-source/index.mdx @@ -0,0 +1,15 @@ +--- +title: "Open source" +--- + +You are reading a legacy (pre v1.0) document. + + +E2B is fully open source including the infrastructure layer. + +- [E2B monorepo containing the SDKs, CLI, and docs](https://github.com/e2b-dev/e2b) +- [E2B infrastructure](https://github.com/e2b-dev/infra) +- [Example code interpreter ChatGPT plugin](https://github.com/e2b-dev/llm-code-interpreter) +- [List of awesome SDKs for AI agents](https://github.com/e2b-dev/awesome-sdks-for-ai-agents) +- [List of awesome AI agents](https://github.com/e2b-dev/awesome-ai-agents) +{/* - [E2B cookbook](https://github.com/e2b-dev/e2b-cookbook) */} diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/pricing/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/pricing/index.mdx new file mode 100644 index 0000000000..011e50d43d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/pricing/index.mdx @@ -0,0 +1,70 @@ +--- +title: "Pricing" +--- + +You are reading a legacy (pre v1.0) document. + + +import SandboxSpec from "/snippets/SandboxSpec.mdx"; + +[Manage Billing](https://e2b.dev/dashboard?tab=billing) + +We charge you based on your real sandbox usage. All new users get one-time free $100 worth of usage in credits. + +--- + +# Plans pricing +Additionally to the usage costs, you can also select a tier that includes dedicated support, prioritized features, and higher sandbox limits. + +## Hobby tier +**$0/month + usage costs** + +- One-time $100 of usage in credits +- Community support +- Up to 1 hour sandbox session length +- Up to 20 concurrently running sandboxes + +## Pro tier +**$150/month + usage costs** + +- One-time $100 of usage in credits +- Dedicated Slack channel with live Pro support from our team +- Prioritized features +- Customize your [sandbox compute](/legacy/sandbox/compute) +- Up to 24 hours sandbox session length +- Up to 100 concurrently running sandboxes + + +If you need any additional features or resources, please [reach out to us](/legacy/getting-help) with your use case. + +--- + +# Compute pricing +We charge per second of a running sandbox. +- vCPU: $0.000014 per second (~$0.05 per hour) +- GiB RAM: $0.0000045 per second (~$0.018 per hour) +- GiB storage: Free + + +1 GiB is equal to 1,024 MiB + + +## Sandbox compute +Pro customers can customize the sandbox with **any combination** of the CPU and RAM based on the following tables. + + +By default your sandbox has 2 vCPU and 512 MiB RAM. + +To customize your sandbox compute, you need to build your custom sandbox template using the [E2B CLI](/legacy/cli/installation). +Run [`e2b template build`](/legacy/cli/commands#template-build) and specify the `--cpu-count` and `--memory-mb` options. + +For example this custom build gives your sandbox 8 vCPU and 4GiB of RAM +```sh +e2b template build --cpu-count 8 --memory-mb 4096 +``` + + + + +
    +[Let us know](/legacy/getting-help) if you need more powerful compute. diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx new file mode 100644 index 0000000000..f15ece5fae --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx @@ -0,0 +1,136 @@ +--- +title: "Current Working Directory" +--- + +You are reading a legacy (pre v1.0) document. + + +You can set a working directory either for the whole sandbox, a filesystem operation, or a new process. + +## Sandbox + +If the current working directory for the sandbox is not set, it will default to the home directory - `/home/user`. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + cwd: '/code', // $HighlightLine +}) + +// You can also change the cwd of an existing sandbox +sandbox.cwd = '/home' // $HighlightLine + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox( + template="base", + cwd="/code", # $HighlightLine +) + +# You can also change the cwd of an existing sandbox +sandbox.cwd = "/home" # $HighlightLine + +sandbox.close() +``` + + +## Filesystem + +All filesystem operations with relative paths are relative to the current working directory. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + cwd: '/home/user/code', // $HighlightLine +}) + +await sandbox.filesystem.write('hello.txt', 'Welcome to E2B!') // $HighlightLine +const proc = await sandbox.process.start({ + cmd: 'cat /home/user/code/hello.txt', +}) +await proc.wait() +console.log(proc.output.stdout) +// output: "Welcome to E2B!" + +await sandbox.filesystem.write('../hello.txt', 'We hope you have a great day!') // $HighlightLine +const proc2 = await sandbox.process.start({cmd: 'cat /home/user/hello.txt'}) +await proc2.wait() +console.log(proc2.output.stdout) +// output: "We hope you have a great day!" + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox( + template="base", + cwd="/home/user/code" # $HighlightLine +) +sandbox.filesystem.write("hello.txt", "Welcome to E2B!") # $HighlightLine +proc = sandbox.process.start("cat /home/user/code/hello.txt") +proc.wait() +print(proc.output.stdout) +# output: "Welcome to E2B!" + +sandbox.filesystem.write("../hello.txt", "We hope you have a great day!") # $HighlightLine +proc2 = sandbox.process.start("cat /home/user/hello.txt") +proc2.wait() +print(proc2.output.stdout) +# output: "We hope you have a great day!" + +sandbox.close() +``` + + +## Process + +If you set a working directory for the sandbox, all processes will inherit it. You can override it for each process. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + cwd: '/code', // $HighlightLine +}) + +const sandboxCwd = await sandbox.process.start({cmd: 'pwd'}) // $HighlightLine +await sandboxCwd.wait() +console.log(sandboxCwd.output.stdout) +// output: /code + +const processCwd = await sandbox.process.start({cmd: 'pwd', cwd: '/home'}) // $HighlightLine +await processCwd.wait() +console.log(processCwd.output.stdout) +// output: /home + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base", cwd="/code") # $HighlightLine +sandbox_cwd = sandbox.process.start("pwd") # $HighlightLine +sandbox_cwd.wait() +print(sandbox_cwd.output.stdout) +# output: "/code" + +process_cwd = sandbox.process.start("pwd", cwd="/home") # $HighlightLine +process_cwd.wait() +print(process_cwd.output.stdout) +# output: "/home" + +sandbox.close() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx new file mode 100644 index 0000000000..5667e30bd1 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx @@ -0,0 +1,79 @@ +--- +title: "Logging" +--- + +You are reading a legacy (pre v1.0) document. + + +export const sections = [ + { title: 'Logging', id: 'logging' }, +] + + + ```text JavaScript & TypeScript + E2B package logs only warnings & errors to the console by default. Below is an example of how to fully customize the logging levels.\n\nFeel free to override the logger with your own implementation with debug, info, warn, and error methods. + ``` + ```text Python + E2B package uses the standard Python logging module You can configure the logging level, handlers and format as you would with any other Python application. \n\nBelow is an example of how to configure the logging module to log to the console. + ``` + + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const logger = { + debug: console.debug, // log debug messages, in default logger this is noop + info: console.info, // log info messages, in default logger this is noop + // don't forget to also specify warn & error handlers, otherwise they won't be logged when overriding the logger + warn: console.warn, + error: console.error, +} + +const sandbox = await Sandbox.create({ + template: 'base', + apiKey: process.env.E2B_API_KEY, + logger, // $HighlightLine +}) +``` +```python Python +import logging +from os import getenv + +from e2b import Sandbox + +E2B_API_KEY = getenv("E2B_API_KEY") + +# Global logging configuration +logging.basicConfig(level=logging.INFO, format="GLOBAL - [%(asctime)s] - %(name)-32s - %(levelname)7s: %(message)s", + datefmt="%Y-%m-%d %H:%M:%S") # $HighlightLine + +# Or configure only e2b logger + +# Get e2b logger +e2b_logger = logging.getLogger("e2b") # $HighlightLine + +# Set e2b logger level to INFO +e2b_logger.setLevel(logging.INFO) # $HighlightLine + +# Setup formatter +formatter = logging.Formatter("E2B - [%(asctime)s] - %(name)-32s - %(levelname)7s: %(message)s", + datefmt="%Y-%m-%d %H:%M:%S") + +# Setup handler +handler = logging.StreamHandler() +handler.setFormatter(formatter) + +# Add handler to e2b logger +e2b_logger.addHandler(handler) # $HighlightLine + + +def main(): + sandbox = Sandbox(template="base", api_key=E2B_API_KEY) + sandbox.filesystem.write("test.txt", "Hello World") + sandbox.close() + + +main() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx new file mode 100644 index 0000000000..0b21871167 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx @@ -0,0 +1,40 @@ +--- +title: "Download files from the sandbox" +--- + +You are reading a legacy (pre v1.0) document. + + +Any file inside the sandbox can be downloaded using the `downloadFile`/`download_file` method. + +## Use case for downloading files +For example, the download file method is useful for downloading any files produced by LLM. You can let LLM generate and execute code inside the sandbox. +This LLM-generated code might produce some files like charts, CSV files, or PDF files that you want to download to your machine. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' +import fs from 'node:fs' + +const sandbox = await Sandbox.create({ template: 'base' }) + +const buffer = await sandbox.downloadFile('path/to/remote/file/inside/sandbox', 'buffer') // $HighlightLine +// Save file to local filesystem +fs.writeFileSync('path/to/local/file', buffer) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +file_in_bytes = sandbox.download_file("path/to/remote/file/inside/sandbox") # $HighlightLine +# Save file to local filesystem +with open("path/to/local/file", "wb") as f: # $HighlightLine + f.write(file_in_bytes) # $HighlightLine + +sandbox.close() +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx new file mode 100644 index 0000000000..29fae5dfc7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx @@ -0,0 +1,79 @@ +--- +title: "Setting environment variables" +--- + +You are reading a legacy (pre v1.0) document. + + +## Global environment variables +You can set the sandbox's global environment variables when initializing a new sandbox. + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + envVars: {FOO: 'Hello'}, // $HighlightLine +}) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox( + template="base", + env_vars={"FOO": "Hello"}, # $HighlightLine +) + +sandbox.close() +``` + + + +## Environment variables per process +Alternatively, you can set environment variables when starting a new process. These environment variables are accessible only for this process. + + +Environment variables set when starting a new process have precedence over the environment variables set when initializing the sandbox. + + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + envVars: {FOO: 'Hello'}, +}) + +const proc = await sandbox.process.start({ + cmd: 'echo $FOO $BAR!', + envVars: {BAR: 'World'}, // $HighlightLine +}) +await proc.wait() +console.log(proc.output.stdout) +// output: Hello World! + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox( + template="base", + env_vars={"FOO": "Hello"} +) + +proc = sandbox.process.start( + "echo $FOO $BAR!", + env_vars={"BAR": "World"}, # $HighlightLine +) +proc.wait() + +print(proc.output.stdout) +# output: Hello World! + +sandbox.close() +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx new file mode 100644 index 0000000000..71fe1e3c27 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx @@ -0,0 +1,276 @@ +--- +title: List directory +--- + +You are reading a legacy (pre v1.0) document. + + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', +}) + +const dirContent = await sandbox.filesystem.list('/') // $HighlightLine +dirContent.forEach((item) => { + console.log(item.name) +}) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +# List the root directory +content = sandbox.filesystem.list("/") # $HighlightLine +for item in content: + print(f"Is '{item.name}' directory?", item.is_dir) + +sandbox.close() +``` + + +## Create directory + +Create directory and all parent directories. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// Create a new directory '/dir' +await sandbox.filesystem.makeDir('/dir') // $HighlightLine + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +# Create a new directory '/dir' +sandbox.filesystem.make_dir("/dir") # $HighlightLine + +sandbox.close() +``` + + +## Write to file + +When writing to a file that doesn't exist, the file will get created. + +When writing to a file that already exists, the file will get overwritten. + +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// `filesystem.write()` will: +// - create the file if it doesn't exist +// - fail if any directory in the path doesn't exist +// - overwrite the file if it exists + +// Write the content of the file '/hello.txt' +await sandbox.filesystem.write('/hello.txt', 'Hello World!') // $HighlightLine + +// The following would fail because '/dir' doesn't exist +// await sandbox.filesystem.write("/dir/hello.txt", "Hello World!") + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +# `filesystem.write()` will: +# - create the file if it doesn't exist +# - fail if any directory in the path doesn't exist +# - overwrite the file if it exists + +# Write the content of the file '/hello.txt' +sandbox.filesystem.write("/hello.txt", "Hello World!") # $HighlightLine + +# The following would fail because '/dir' doesn't exist +# sandbox.filesystem.write("/dir/hello.txt", "Hello World!") + +sandbox.close() +``` + + +## Read from file + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +const fileContent = await sandbox.filesystem.read('/etc/hosts') // $HighlightLine +console.log(fileContent) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +# Read the '/etc/hosts' file +file_content = sandbox.filesystem.read("/etc/hosts") # $HighlightLine + +# Prints something like: +# 127.0.0.1 localhost +print(file_content) + +sandbox.close() +``` + + +## Write bytes + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// Let's convert string to bytes for testing purposes +const encoder = new TextEncoder('utf-8') +const contentInBytes = encoder.encode('Hello World!') + +// `writeBytes` accepts a Uint8Array and saves it to a file inside the playground +await sandbox.filesystem.writeBytes('/file', contentInBytes) // $HighlightLine + +// We can read the file back to verify the content +const fileContent = await sandbox.filesystem.read('/file') + +// This will print 'Hello World!' +console.log(fileContent) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +content_in_bytes = bytearray(b"Hello world") + +# `write_bytes` will write bytearray to a file inside the playground. +sandbox.filesystem.write_bytes("/file", content_in_bytes) # $HighlightLine + +# We can read the file back to verify the content +file_content = sandbox.filesystem.read("/file") +print(file_content) + +sandbox.close() +``` + + +## Read bytes + + +```js JavaScript & TypeScript +import fs from 'fs' +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// File bytes will read file's content as bytes +// `fileBytes` as a Uint8Array +const fileBytes = await sandbox.filesystem.readBytes('/etc/hosts') // $HighlightLine + +// The output will look similar to this: +// + +## Watch directory for changes + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// Start filesystem watcher for the /home directory +const watcher = sandbox.filesystem.watchDir('/home') // $HighlightLine +watcher.addEventListener((event) => { + // $HighlightLine + console.log('Filesystem event', event) // $HighlightLine +}) // $HighlightLine +await watcher.start() // $HighlightLine + +// Create files in the /home directory inside the playground +// We'll receive notifications for these events through the watcher we created above. +for (let i = 0; i < 10; i++) { + console.log('Creating file', i) + // `filesystem.write()` will trigger two events: + // 1. 'Create' when the file is created + // 2. 'Write' when the file is written to + await sandbox.filesystem.write(`/home/${i}.txt`, `Hello World ${i}!`) +} + +await sandbox.close() +``` +```python Python +import time + +from e2b import Sandbox + +sandbox = Sandbox.create() + +watcher = sandbox.files.watch_dir("/home") # $HighlightLine + +# Create files in the /home directory inside the playground +# We'll receive notifications for these events through the watcher we created above. +for i in range(10): + # `filesystem.write()` will trigger two events: + # 1. 'Create' when the file is created + # 2. 'Write' when the file is written to + sandbox.files.write(f"/home/file{i}.txt", f"Hello World {i}!") + time.sleep(1) + +for event in watcher.get(): + print(f"Event: {event.type} {event.name}") # $HighlightLine + +watcher.stop() +sandbox.kill() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx new file mode 100644 index 0000000000..49855db1c0 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx @@ -0,0 +1,66 @@ +--- +title: Sandbox metadata +--- + +You are reading a legacy (pre v1.0) document. + + +You can assign metadata to your sandbox. This metadata will be available if you call `Sandbox.list()`. This can be useful in a situation where each of your users have dedicated sandbox and the time between the steps of the integration is long. You can use the metadata to store the user id and reconnect to it later. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + metadata: { userID: 'uniqueID' } // $HighlightLine +}) +// Keep the sandbox alive for 60 seconds +await sandbox.keepAlive(60_000) +// You can even close the script + +// Later, can be even from another process +// List all running sandboxes +const paginator = Sandbox.list({ query: {state: ['running']}}) +const runningSandboxes = await paginator.nextItems() +// Find the sandbox by metadata +const found = runningSandboxes.find(s => s.metadata?.userID === 'uniqueID') +if (found) { + // Sandbox found, we can reconnect to it + const sandbox = await Sandbox.reconnect(found.sandboxID) +} else { + // Sandbox not found +} + +await sandbox.close() +``` +```python Python +from e2b import Sandbox, SandboxState +from e2b.sandbox.sandbox_api import SandboxQuery + +sandbox = Sandbox( + template="base", + metadata={"user_id": "uniqueID"}, # $HighlightLine +) + +# Keep the sandbox alive for 60 seconds +sandbox.set_timeout(60) +# You can even close the script + +# Later, can be even from another process +# List all running sandboxes +paginator = Sandbox.list(query=SandboxQuery(state=[SandboxState.RUNNING])) +running_sandboxes = paginator.next_items() + +# Find the sandbox by metadata +for running_sandbox in running_sandboxes: + if running_sandbox.metadata.get("user_id", "") == "uniqueID": + sandbox = Sandbox.connect(running_sandbox.sandbox_id) + break +else: + # Sandbox not found + pass + +sandbox.close() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx new file mode 100644 index 0000000000..5662be01f7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx @@ -0,0 +1,269 @@ +--- +title: "Starting process inside a sandbox" +--- + +You are reading a legacy (pre v1.0) document. + + +Here are the basic operations you can do with the process inside the sandbox: + +- [Start process](#start-process) +- [Stop process](#stop-process) +- [Stdout](#stream-stdout) +- [Stdin](#send-stdin) +- [Stderr](#stream-stderr) +- [On exit](#on-process-exit) + +## Start process + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +const npmInit = await sandbox.process.start({ + cmd: 'npm init -y', // $HighlightLine +}) +await npmInit.wait() + +console.log(npmInit.output.stdout) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +npm_init = sandbox.process.start("npm init -y") # $HighlightLine +npm_init.wait() +print(npm_init.stdout) + +sandbox.close() +``` + + +## Stop process + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', +}) + +const npmInit = await sandbox.process.start({ + cmd: 'npm init -y', +}) +await npmInit.kill() // $HighlightLine +// There will be no output because we immediately kill the `npm_init` process +console.log(npmInit.output.stdout) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +npm_init = sandbox.process.start("npm init -y") +npm_init.kill() # $HighlightLine + +# There will be no output because we immediately kill the `npm_init` process +print(npm_init.stdout) + +sandbox.close() +``` + + +## Stream stdout + +Set either stdout handler for the whole sandbox level or per process. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + onStdout: (output) => console.log('sandbox', output.line), // $HighlightLine +}) + +const proc = await sandbox.process.start({ + cmd: 'echo "Hello World!"', +}) +await proc.wait() +// output: sandbox Hello World! + +const procWithCustomHandler = await sandbox.process.start({ + cmd: 'echo "Hello World!"', + onStdout: (data) => console.log('process', data.line), // $HighlightLine +}) +await procWithCustomHandler.wait() +// output: process Hello World! + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox( + template="base", + on_stdout=lambda output: print("sandbox", output.line), # $HighlightLine +) + +proc = sandbox.process.start('echo "Hello World!"') +proc.wait() +# output: sandbox Hello World! + +proc_with_custom_handler = sandbox.process.start( + 'echo "Hello World!"', + on_stdout=lambda output: print("process", output.line), # $HighlightLine +) +proc_with_custom_handler.wait() +# output: process Hello World! + +sandbox.close() +``` + + +## Stream stderr + +Set either stderr handler for the whole sandbox level or per process. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', +}) + +// This command will fail and output to stderr because Golang isn't installed in the cloud playground +const golangVersion = await sandbox.process.start({ + cmd: 'go version', + onStderr: (output) => console.log('sandbox', output.line), // $HighlightLine +}) +await golangVersion.wait() +// output: [sandbox] /bin/bash: line 1: go: command not found + +const procWithCustomHandler = await sandbox.process.start({ + cmd: 'go version', + onStderr: (data) => console.log('process', data.line), // $HighlightLine +}) +await procWithCustomHandler.wait() +// output: process /bin/bash: line 1: go: command not found + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox( + template="base", + on_stderr=lambda output: print("[sandbox]", output.line), # $HighlightLine +) + +# This command will fail and output to stderr because Golang isn't installed in the cloud playground +proc = sandbox.process.start("go version") +proc.wait() +# output: [sandbox] /bin/bash: line 1: go: command not found + +proc_with_custom_handler = sandbox.process.start( + "go version", + on_stderr=lambda output: print("[process]", output.line), # $HighlightLine +) +proc_with_custom_handler.wait() +# output: [process] /bin/bash: line 1: go: command not found + +sandbox.close() +``` + + +## On process exit + +Set either on exit handler for the whole sandbox level or per process. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ + template: 'base', + onExit: () => console.log('[sandbox]', 'process ended'), // $HighlightLine +}) + +const proc = await sandbox.process.start({cmd: 'echo "Hello World!"'}) +await proc.wait() +// output: [sandbox] process ended + +const procWithCustomHandler = await sandbox.process.start({ + cmd: 'echo "Hello World!"', + onExit: () => console.log('[process]', 'process ended'), // $HighlightLine +}) +await procWithCustomHandler.wait() +// output: [process] process ended + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox( + template="base", + on_exit=lambda: print("[sandbox]", "process ended"), # $HighlightLine +) + +proc = sandbox.process.start('echo "Hello World!"') +proc.wait() +# output: [sandbox] process ended + +proc_with_custom_handler = sandbox.process.start( + 'echo "Hello World!"', + on_exit=lambda: print("[process]", "process ended"), # $HighlightLine +) +proc_with_custom_handler.wait() +# output: [process] process ended + +sandbox.close() +``` + + +## Send stdin + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// This example will print back the string we send to the process using `sendStdin()` + +const proc = await sandbox.process.start({ + cmd: 'while IFS= read -r line; do echo "$line"; sleep 1; done', + onStdout: (output) => console.log(output), +}) +await proc.sendStdin('AI Playground\n') // $HighlightLine +await proc.kill() + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +# This example will print back the string we send to the process using `send_stdin()` + +proc = sandbox.process.start( + 'while IFS= read -r line; do echo "$line"; sleep 1; done', + on_stdout=print, +) +proc.send_stdin("AI Playground\n") # $HighlightLine +proc.kill() + +sandbox.close() +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx new file mode 100644 index 0000000000..d217450ed4 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx @@ -0,0 +1,110 @@ +--- +title: "Connect to running sandbox" +--- + +You are reading a legacy (pre v1.0) document. + + +Disconnect and reconnect later to the same sandbox while keeping it alive + +## Description + +The sandboxes are by default kept alive only when connected to them. When you disconnect from a sandbox, it will be destroyed. + +If you want to keep the sandbox alive even after disconnecting from it, you can explicitly say for how long you want to keep it alive. You can then disconnect from the sandbox and reconnect to it later. This can be useful for example in a **serverless environment** or **chatbot application**. + +The duration limit to keep the sandbox alive is 1 hour. If you need more, feel free to [reach out to us](/legacy/getting-help) with your use. + +## Keep sandbox alive + +The example below shows how to disconnect from a running sandbox and reconnect to it again while keeping the sandbox alive. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +async function wait(ms) { + return new Promise(resolve => setTimeout(resolve, ms)) +} + +const sandbox = await Sandbox.create({ template: 'base' }) +``` +```python Python +import time +from e2b import Sandbox + + +sandbox = Sandbox('base') +``` + + +Call the `keep_alive`/`keepAlive` method on the sandbox instance to keep it alive. You can specify the preferred duration, as a multiple of a default time unit, which is +- 1ms in JS +- 1s in Python. + +You then disconnect from the sandbox. + + +```js JavaScript & TypeScript +// Do something in the sandbox +await sandbox.filesystem.write('hello.txt', 'Hello World!') + +// Get the sandbox ID, we'll need it later +const sandboxID = sandbox.id + +// Keep alive the sandbox for 2 minutes +await sandbox.keepAlive(2 * 60 * 1000) // 2 minutes $HighlightLine + +// Close the sandbox. Even if we close the sandbox, it will stay alive, because we explicitly called keepAlive(). +await sandbox.close() + +// Do something else... +await wait(60 * 1000) +``` +```python Python +# Do something in the sandbox +sandbox.filesystem.write('hello.txt', 'Hello World!') + +# Get the sandbox ID, we'll need it later +sandboxID = sandbox.id + +# Keep the sandbox alive for 2 minutes +sandbox.keep_alive(60 * 2) # $HighlightLine + +# Close the sandbox. Even if we close the sandbox, it will stay alive, because we explicitly called keep_alive(). +sandbox.close() + +# Do something else... +time.sleep(60) +``` + + +You can then reconnect to the sandbox from anywhere. + + +```js JavaScript & TypeScript +// Reconnect to the sandbox +const sandbox2 = await Sandbox.reconnect(sandboxID) // $HighlightLine + +// Continue in using the sandbox +const content = await sandbox2.filesystem.read('hello.txt') +console.log(content) + +// Close the sandbox +await sandbox2.close() +``` +```python Python +# Reconnect to the sandbox +sandbox2 = Sandbox.reconnect(sandboxID) # $HighlightLine + +# Continue in using the sandbox +content = sandbox2.filesystem.read('hello.txt') +print(content) + +# Close the sandbox +sandbox2.close() +``` + + +## Use sandbox metadata +Sandbox metadata can be very useful to store information about the sandbox. You can use it to store the user ID or any other information you need to keep track of and then use this info for reconnecting to the sandbox. You can read more about sandbox metadata [here](/legacy/sandbox/api/metadata). \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx new file mode 100644 index 0000000000..bbcd06b020 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx @@ -0,0 +1,100 @@ +--- +title: "Timeouts" +--- + +You are reading a legacy (pre v1.0) document. + + +The SDK has a number of timeouts that can be configured to control how long the SDK will wait for a response from the E2B servers. **The default is 60 seconds.** + +## Timeout creating sandbox + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +// Timeout 3s for the sandbox to open +const sandbox = await Sandbox.create({ + template: 'base', + timeout: 3000, // $HighlightLine +}) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +# Timeout 3s for the sandbox to open +sandbox = Sandbox(template="base", timeout=3) # $HighlightLine + +sandbox.close() +``` + + +## Timeout process + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// Timeout 3s for the process to start +const npmInit = await sandbox.process.start({ + cmd: 'npm init -y', + timeout: 3000, // $HighlightLine +}) +await npmInit.wait() + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +# Timeout 3s for the process to start +npm_init = sandbox.process.start("npm init -y", timeout=3) # $HighlightLine +npm_init.wait() + +sandbox.close() +``` + + +## Timeout filesystem operations + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// Timeout 3s for the write operation +await sandbox.filesystem.write('hello.txt', 'Hello World!', {timeout: 3000}) // $HighlightLine + +// Timeout 3s for the list operation +const files = await sandbox.filesystem.list('.', {timeout: 3000}) // $HighlightLine +console.log(files) + +// Timeout 3s for the read operation +const content = await sandbox.filesystem.read('hello.txt', {timeout: 3000}) // $HighlightLine +console.log(content) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +# Timeout 3s for the write operation +sandbox.filesystem.write("test.txt", "Hello World", timeout=3) # $HighlightLine + +# Timeout 3s for the list operation +dir_content = sandbox.filesystem.list(".", timeout=3) # $HighlightLine +print(dir_content) + +# Timeout 3s for the read operation +file_content = sandbox.filesystem.read("test.txt", timeout=3) # $HighlightLine +print(file_content) + +sandbox.close() +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx new file mode 100644 index 0000000000..e3f5021da7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx @@ -0,0 +1,56 @@ +--- +title: "Upload files to sandbox" +--- + +You are reading a legacy (pre v1.0) document. + + +You can upload any file to the sandbox. This is useful if you want to let the LLM work with your files or files of your users. The file will be uploaded to the user's home directory with the same name. If a file with the same name already exists, it will be overwritten. + +## Use case for uploading files +A popular workflow is for example to upload a CSV data file and then let the LLM generate and execute Python code that operates with the uploaded CSV file inside the sandbox. This way, you can essentially create your own AI data analyst or code interpreter. + + +We support uploading files up to 100MB at the moment. If you need to upload larger files, please [reach out to us](/legacy/getting-help). + + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' +import fs from 'node:fs' + +const sandbox = await Sandbox.create({ template: 'base' }) + +// If you're in the server environment +const filename = 'data.csv' // $HighlightLine +const fileBuffer = fs.readFileSync('path/to/local/file') // $HighlightLine +const remotePath = await sandbox.uploadFile(fileBuffer, filename) // $HighlightLine + +// If you're in the browser environment, you can use the Blob API +// const filename = 'data.csv' +// const CSV = [ +// '"1","val1","val2","val3","val4"', +// '"2","val1","val2","val3","val4"', +// '"3","val1","val2","val3","val4"' +// ].join('\n'); +// const fileBlob = new Blob([csv], { type: 'text/csv' }) +// const remotePath = await sandbox.uploadFile(fileBlob, 'data.csv') + +console.log( + `The file was uploaded to '${remotePath}' path inside the sandbox `, +) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +with open("path/to/local/file", "rb") as f: + remote_path = sandbox.upload_file(f) # $HighlightLine + +sandbox.close() +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx new file mode 100644 index 0000000000..b835e16a04 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx @@ -0,0 +1,60 @@ +--- +title: "Sandbox URL" +--- + +You are reading a legacy (pre v1.0) document. + + +Each sandbox has its own URL that you can use to connect to any service running inside the sandbox. + +For example, you can start a server inside the sandbox and connect to it from your browser. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +const url = sandbox.getHostname() // $HighlightLine +console.log('https://' + url) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +url = sandbox.get_host() # $HighlightLine +print("https://" + url) + +sandbox.close() +``` + + + +If you want to get an URL for a specific port inside the sandbox, pass the port number to the `getHostname()`/`get_hostname()` method. + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: 'base' }) + +const openPort = 3000 +const url = sandbox.getHostname(openPort) // $HighlightLine +console.log('https://' + url) + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox(template="base") + +open_port = 3000 +url = sandbox.get_host(open_port) # $HighlightLine +print("https://" + url) + +sandbox.close() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/compute/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/compute/index.mdx new file mode 100644 index 0000000000..eec0fb8652 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/compute/index.mdx @@ -0,0 +1,31 @@ +--- +title: "Sandbox compute" +--- + +You are reading a legacy (pre v1.0) document. + + +import SandboxSpec from "/snippets/SandboxSpec.mdx"; + +# Sandbox compute +Pro customers can customize the sandbox with **any combination** of the CPU and RAM based on the following tables. + +Read a dedicated page to [learn more about pricing](/legacy/pricing). + + +**By default your sandbox has 2 vCPU and 512 MiB RAM.** + +To customize your sandbox compute, you need to build your custom sandbox template using the [E2B CLI](/legacy/cli/installation). +Run [`e2b template build`](/legacy/cli/commands#template-build) and specify the `--cpu-count` and `--memory-mb` options. + +For example, this custom build command gives your sandbox 8 vCPU and 4GiB of RAM +```sh +e2b template build --cpu-count 8 --memory-mb 4096 +``` + + + + +
    + +[Let us know](/legacy/getting-help) if you need more powerful compute. \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/custom/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/custom/index.mdx new file mode 100644 index 0000000000..c728220f97 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/custom/index.mdx @@ -0,0 +1,55 @@ +--- +title: "Customizing Sandbox" +--- + +You are reading a legacy (pre v1.0) document. + + +Custom sandboxes allows you to spawn a sandbox with a pre-defined environment by you and then control it with our SDK. + +You can build a custom sandbox by creating the [Sandbox Template](/legacy/sandbox/templates/overview). Sandbox template is a Dockerfile that describes the environment of your sandbox. + +Once you build your custom sandbox template, you can spawn multiple isolated sandboxes from it. + +## How it works +1. [Provide the sandbox template file](/legacy/sandbox/templates/template-file) +1. [Build a sandbox template from it using our CLI](/legacy/guide/custom-sandbox#4-build-custom-sandbox) +1. Get a template ID from the CLI: + ```sh + # ... truncated CLI output + ✅ Building sandbox template 3y5bvra6kgq0kaumgztu finished. + ``` +1. Pass the template ID to our SDK like this: + + ```js JavaScript & TypeScript + import { Sandbox } from 'e2b' + + // Create new sandbox + const sandbox = await Sandbox.create({ + template: '', // You get sandbox template ID from the CLI after you run `$ e2b template build` + }) + + // Close sandbox once done + await sandbox.close() + ``` + + ```python Python + from e2b import Sandbox + + # Create new sandbox + sandbox = Sandbox.create( + template="", # You get sandbox template from the CLI after you run `$ e2b template build` + ) + + # Close sandbox once done + sandbox.close() + ``` + +1. Run the code and we spawn a sandbox based on the template you built in step 2 + +Now you can do step 4/5 multiple times using the same ID, always creating a separate sandbox instance. + + + +Read more on [Sandbox Templates](/legacy/sandbox/templates/overview) if you want to create your own custom sandbox. + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/overview/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/overview/index.mdx new file mode 100644 index 0000000000..3521393bd3 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/overview/index.mdx @@ -0,0 +1,81 @@ +--- +title: "Overview" +--- + +You are reading a legacy (pre v1.0) document. + + +**The E2B's sandboxes are isolated cloud environments made specifcially for AI code interpreting or code execution.** + +The E2B sandboxes are an ideal fit as a playground for AI assistants like coding copilots, code interpreters, AI data analysts, AI browser assistants, and other AI-powered apps. + +## Features + + [Open-source](https://github.com/e2b-dev/e2b) sandbox for LLMA full VM environmentNo need for orchestration or infrastructure managementAbility to give each user of your AI app their own isolated environment + + [Python & Node.js SDK](/legacy/getting-started/installation) for controling the sandbox's + + [filesystem](/legacy/sandbox/api/filesystem), + + [processes](/legacy/sandbox/api/process), and more.Support for up to 24h long-running sandbox sessionsAbility to + + [upload files](/legacy/sandbox/api/upload) to the sandbox and + + [download files](/legacy/sandbox/api/download) from the sandbox, + + +With more features coming in the future: +- Out-of-the box working monitoring of what's happening inside the sandbox +- LLM Access control to data, tools, and any internet requests +- Statefull sandboxes +- Resumable workflows (pause sandbox and load it later) +- Unlimited long-running sandboxed + +## Comparison to other services +With LLMs, it's not safe to let the LLM run code and use tools in the same environment where your application is running. + +You need to isolate the LLM from the rest of your app and make sure that the LLM can't access your data, tools, and the internet without you knowing about it or giving it explicit access. You need to make sure that the LLM can run untrusted code safely and install libraries on fly. +The AI apps also often need to run for a long time, and need to be resumable - for example, when waiting for user's consent to make an internet purchase, you need to be able to pause the AI app and resume it later without losing the whole state. + +Additionally, the AI apps present need for a new model: +- How can every user of your AI app have the environment described above for themselves? +- How can developers easily manage and orchestrate these environments? +- How can developers easily debug these environments? +- How to let LLMs use the same tools as humans do on their computers (for example browser, code linters, autocomplete, etc)? +- How can developers easily monitor what's happening inside these environments? +- How to scale these environments to billions of instances? + + + + + +E2B Sandboxes are made exactly to solve these challenges. The sandbox is like an isolated runtime or playground for the LLM. **We give you our SDK to spawn and control these sandboxes.** + + +## How sandboxes work under the hood +When you create a new sandbox session, we start a small VM in our cloud. This VM is running a Ubuntu OS and it takes about 400-600ms to start it. + +Inside this sandbox, your AI app can [run code and start any programs](/legacy/sandbox/api/process), access the internet to download or upload data, use the [filesystem](/legacy/sandbox/api/filesystem), start long running processes such as web servers, and more. +You can also [upload](/legacy/sandbox/api/upload) to sandbox and [download](/legacy/sandbox/api/upload) from sandbox any file you want. + +To start and control the sandbox, use the [E2B SDK](/legacy/getting-started/installation) for Python or JavaScript. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() + +await sandbox.close() +``` +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +sandbox.close() +``` + + + +Make sure you have the `E2B_API_KEY` environment variable set with your [API key](/legacy/getting-started/api-key). + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx new file mode 100644 index 0000000000..81521cc10c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx @@ -0,0 +1,68 @@ +--- +title: "Custom Sandbox" +--- + +You are reading a legacy (pre v1.0) document. + + +Custom sandboxes allow you to spawn a sandbox with an environment predefined by you and then control it with our SDK. + + +The E2B Sandbox is a secure way to run your AI app. It is a long-running cloud environment where you can let any LLM (GPTs, Claude, local LLMs, etc) use tools exactly like you would do locally. + +Read more about E2B Sandboxes [here](/legacy/sandbox/overview). + + + +## How Custom Sandboxes Work + + +Follow our [guide](/legacy/guide/custom-sandbox) on how to create a custom sandbox. + + +1. You build a custom sandbox by creating the [Sandbox Template](/legacy/sandbox/templates/template-file) which is a Dockerfile describing the environment of your sandbox. +1. Build a sandbox template from it using our CLI +1. Get a template ID from the CLI: + ```sh + # ... truncated CLI output + ✅ Building sandbox template 3y5bvra6kgq0kaumgztu finished. + ``` +1. Pass the template ID to our SDK like this: + + ```js JavaScript & TypeScript + import { Sandbox } from 'e2b' + + // Create new sandbox + const sandbox = await Sandbox.create({ + // You get sandbox template from the CLI after you run `$ e2b template build` + template: '', // $HighlightLine + }) + + // Close sandbox once done + await sandbox.close() + ``` + + ```python Python + from e2b import Sandbox + + # Create new sandbox + sandbox = Sandbox.create( + # You get sandbox template from the CLI after you run `$ e2b template build` + template="", # $HighlightLine + ) + + # Close sandbox once done + sandbox.close() + ``` + +1. Run the code and we spawn a sandbox based on the template you built in step 2 + +Once you build your custom sandbox template, you can spawn multiple isolated sandboxes from it. You can repeat the steps 4, 5 multiple times using the same ID, always creating a separate sandbox instance. + + + + + + +Follow [our guide](/legacy/guide/custom-sandbox) on how to create a custom sandbox. + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/template-file/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/template-file/index.mdx new file mode 100644 index 0000000000..c7e9555815 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/template-file/index.mdx @@ -0,0 +1,49 @@ +--- +title: "Template File" +--- + +You are reading a legacy (pre v1.0) document. + + +The template file is a Dockerfile named `e2b.Dockerfile`. The template file is used to define an environment for your custom sandbox. + + +Follow our [guide](/legacy/guide/custom-sandbox) on how to create a custom sandbox. + + + + + + +## `e2b.Dockerfile` +The Dockerfile must be Debian based (e.g. Ubuntu). Only the following [Dockerfile commands](https://docs.docker.com/engine/reference/builder/) are supported: + - `FROM` + - `ADD` + - `COPY` + - `RUN` + - `WORKDIR` + - `ARG` + +## Example + +The following example template file defines a Ubuntu-based sandbox with installed GitHub CLI. + + + +```sh +# You can use most of the Debian-based base images +FROM ubuntu:22.04 + +# Install dependencies and customize sandbox +RUN apt update \ + && apt install sudo + +# Install GitHub CLI +RUN type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y) +RUN curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \ + && sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \ + && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \ + && sudo apt update \ + && sudo apt install gh -y +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/supported/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/supported/index.mdx new file mode 100644 index 0000000000..645360a999 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/supported/index.mdx @@ -0,0 +1,15 @@ +--- +title: "Supported LLMs and AI frameworks" +--- + +You are reading a legacy (pre v1.0) document. + + +E2B is LLM agnostic - it supports any LLM models and any AI frameworks. + +Usually, all you need from the model is just support for tool use. You then use the E2B code interpreter as a tool. +If the LLM doesn't support tool use, you can ask the LLM to respond with Markdown or XML and parse the LLM's output on your own. Then just pass the parsed code from code blocks to the code interpreter. + + +Check out our [cookbook](https://github.com/e2b-dev/e2b-cookbook) for examples. + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/logo/logo_dark.svg b/apps/web/src/app/(docs)/mintlify-docs/logo/logo_dark.svg new file mode 100644 index 0000000000..51c7a9247e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/logo/logo_dark.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/logo/logo_light.svg b/apps/web/src/app/(docs)/mintlify-docs/logo/logo_light.svg new file mode 100644 index 0000000000..bde45a2f40 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/logo/logo_light.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/logo/white.svg b/apps/web/src/app/(docs)/mintlify-docs/logo/white.svg new file mode 100644 index 0000000000..b8fb4e8928 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/logo/white.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/migration/v2/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/migration/v2/index.mdx new file mode 100644 index 0000000000..b478426e2e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/migration/v2/index.mdx @@ -0,0 +1,146 @@ +--- +title: "SDK v2 Migration Guide" +--- + +This guide helps you migrate from E2B SDK v1 to v2, covering all breaking changes and new patterns. + +## Table of contents + +SDK v2 introduces several important changes: +- [**New creation pattern in Python Synchronous SDK**](#1-sandbox-creation-in-synchronous-python-sdk) +- [**Secure by default**](#2-secure-communication-by-default) +- [**Updated file operations in Python SDK**](#3-file-writing-in-python-sdk) +- [**Updated list method**](#4-listing-sandboxes) + +## Breaking changes + +### 1. Sandbox creation in synchronous Python SDK + +In v2, the synchronous Python SDK uses a class method `create()` instead of the constructor `Sandbox()`. + + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() +sandbox = Sandbox.create(template="base") +``` + + +In the v1, you would instantiate directly: + + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +sandbox = Sandbox(template="base") +``` + + +### 2. Secure communication by default + +Sandboxes are now **secure by default**. That means you cannot access the sandbox directly via its URL; there's authentication required. If you use the SDK, this is handled for you automatically. + +This shouldn't affect you, but if you need to access sandbox directly without SDK and you are now getting 401, you may need to set `secure` to `false`. + + + If you are using custom code interpreter templates, it may be necessary to rebuild the template to ensure compatibility with secure sandboxes. + + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create({ secure: false }) // Explicitly disable +``` + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create(secure=False) # Explicitly disable +``` + + +### 3. File writing in Python SDK + +The file writing API in Python has been made more consistent. + +In v2, use `sandbox.files.write()` for single files and `sandbox.files.write_files()` for multiple files: + +```python v2 +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Write single file +info = sandbox.files.write("/tmp/file.txt", "content") + +# Write multiple files +infos = sandbox.files.write_files([ + {"path": "/tmp/file1.txt", "data": "content1"}, + {"path": "/tmp/file2.txt", "data": "content2"} +]) +``` + + +In v1, the same `write()` method was overloaded for both single and multiple files: + + +```python v1 +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Write single file +info = sandbox.write(path="/tmp/file.txt", data="content") + +# Write multiple files +infos = sandbox.write([ + {"path": "/tmp/file1.txt", "data": "content1"}, + {"path": "/tmp/file2.txt", "data": "content2"} +]) +``` + + +### 4. Listing sandboxes + +The method for listing sandboxes has been updated to use pagination. + + +```js JavaScript & TypeScript +import { Sandbox, SandboxInfo } from '@e2b/code-interpreter' + +// Get paginator +const paginator = Sandbox.list() + +// Iterate through all sandboxes +for (const sandbox of await paginator.nextItems()) { + console.log(sandbox.sandboxId) +} + +// Iterate through all sandboxes +const allSandboxes: SandboxInfo[] = [] +while (paginator.hasNext) { + const items = await paginator.nextItems() + allSandboxes.push(...items) +} + +// With query +const queryPaginator = Sandbox.list({query: {metadata: {key: "value"}}}) +``` +```python Python +from e2b_code_interpreter import Sandbox, SandboxQuery + +# Get paginator +paginator = Sandbox.list() + +# Iterate through all sandboxes +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) + +# With query +paginator = Sandbox.list(query=SandboxQuery(metadata={"key": "value"})) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/quickstart/connect-llms/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/quickstart/connect-llms/index.mdx new file mode 100644 index 0000000000..adfbc664d1 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/quickstart/connect-llms/index.mdx @@ -0,0 +1,807 @@ +--- +title: "Connect LLMs to E2B" +--- + +E2B can work with any LLM and AI framework. The easiest way to connect an LLM to E2B is to use the tool use capabilities of the LLM (sometimes known as function calling). + +If the LLM doesn't support tool use, you can, for example, prompt the LLM to output code snippets and then manually extract the code snippets with [RegEx](https://en.wikipedia.org/wiki/Regular_expression). + +## Contents +- [OpenAI](#openai) +- [Anthropic](#anthropic) +- [Mistral](#mistral) +- [Groq](#groq) +- [Vercel AI SDK](#vercel-ai-sdk) +- [CrewAI](#crewai) +- [LangChain](#langchain) +- [LlamaIndex](#llamaindex) +- [Ollama](#ollama) +- [Hugging Face](#hugging-face) + +--- + +## OpenAI + +### Simple + + +```python Python +# pip install openai e2b-code-interpreter +from openai import OpenAI +from e2b_code_interpreter import Sandbox + +# Create OpenAI client +client = OpenAI() +system = "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." +prompt = "Calculate how many r's are in the word 'strawberry'" + +# Send messages to OpenAI API +response = client.chat.completions.create( + model="gpt-4o", + messages=[ + {"role": "system", "content": system}, + {"role": "user", "content": prompt} + ] +) + +# Extract the code from the response +code = response.choices[0].message.content + +# Execute code in E2B Sandbox +if code: + with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + result = execution.text + + print(result) +``` + + +### Function calling + + +```python Python +# pip install openai e2b-code-interpreter +import json +from openai import OpenAI +from e2b_code_interpreter import Sandbox + +# Create OpenAI client +client = OpenAI() +model = "gpt-4o" + +# Define the messages +messages = [ + { + "role": "user", + "content": "Calculate how many r's are in the word 'strawberry'" + } +] + +# Define the tools +tools = [{ + "type": "function", + "function": { + "name": "execute_python", + "description": "Execute python code in a Jupyter notebook cell and return result", + "parameters": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The python code to execute in a single cell" + } + }, + "required": ["code"] + } + } +}] + +# Generate text with OpenAI +response = client.chat.completions.create( + model=model, + messages=messages, + tools=tools, +) + +# Append the response message to the messages list +response_message = response.choices[0].message +messages.append(response_message) + +# Execute the tool if it's called by the model +if response_message.tool_calls: + for tool_call in response_message.tool_calls: + if tool_call.function.name == "execute_python": + # Create a sandbox and execute the code + with Sandbox.create() as sandbox: + code = json.loads(tool_call.function.arguments)['code'] + execution = sandbox.run_code(code) + result = execution.text + + # Send the result back to the model + messages.append({ + "role": "tool", + "name": "execute_python", + "content": result, + "tool_call_id": tool_call.id, + }) + +# Generate the final response +final_response = client.chat.completions.create( + model=model, + messages=messages +) + +print(final_response.choices[0].message.content) +``` + + +--- + +## Anthropic + +### Simple + + +```python Python +# pip install anthropic e2b-code-interpreter +from anthropic import Anthropic +from e2b_code_interpreter import Sandbox + +# Create Anthropic client +anthropic = Anthropic() +system_prompt = "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." +prompt = "Calculate how many r's are in the word 'strawberry'" + +# Send messages to Anthropic API +response = anthropic.messages.create( + model="claude-3-5-sonnet-20240620", + max_tokens=1024, + messages=[ + {"role": "assistant", "content": system_prompt}, + {"role": "user", "content": prompt} + ] +) + +# Extract code from response +code = response.content[0].text + +# Execute code in E2B Sandbox +with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + result = execution.logs.stdout + +print(result) +``` + + +### Function calling + + +```python Python +# pip install anthropic e2b-code-interpreter +from anthropic import Anthropic +from e2b_code_interpreter import Sandbox + +# Create Anthropic client +client = Anthropic() +model = "claude-3-5-sonnet-20240620" + +# Define the messages +messages = [ + { + "role": "user", + "content": "Calculate how many r's are in the word 'strawberry'" + } +] + +# Define the tools +tools = [{ + "name": "execute_python", + "description": "Execute python code in a Jupyter notebook cell and return (not print) the result", + "input_schema": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The python code to execute in a single cell" + } + }, + "required": ["code"] + } +}] + +# Generate text with Anthropic +message = client.messages.create( + model=model, + max_tokens=1024, + messages=messages, + tools=tools +) + +# Append the response message to the messages list +messages.append({ + "role": "assistant", + "content": message.content +}) + +# Execute the tool if it's called by the model +if message.stop_reason == "tool_use": + tool_use = next(block for block in message.content if block.type == "tool_use") + tool_name = tool_use.name + tool_input = tool_use.input + + if tool_name == "execute_python": + with Sandbox.create() as sandbox: + code = tool_input['code'] + execution = sandbox.run_code(code) + result = execution.text + + # Append the tool result to the messages list + messages.append({ + "role": "user", + "content": [ + { + "type": "tool_result", + "tool_use_id": tool_use.id, + "content": result, + } + ], + }) + +# Generate the final response +final_response = client.messages.create( + model=model, + max_tokens=1024, + messages=messages, + tools=tools +) + +print(final_response.content[0].text) +``` + + +--- + +## Mistral + +### Simple + + +```python Python +# pip install mistralai e2b-code-interpreter +import os +from mistralai import Mistral +from e2b_code_interpreter import Sandbox + +# Create Mistral client +client = Mistral(api_key=os.environ["MISTRAL_API_KEY"]) +system_prompt = "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." +prompt = "Calculate how many r's are in the word 'strawberry'" + +# Send the prompt to the model +response = client.chat.complete( + model="codestral-latest", + messages=[ + {"role": "system", "content": system_prompt}, + {"role": "user", "content": prompt} + ] +) + +# Extract the code from the response +code = response.choices[0].message.content + +# Execute code in E2B Sandbox +with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + result = execution.text + +print(result) +``` + + +### Function calling + + +```python Python +# pip install mistralai e2b-code-interpreter +import os +import json +from mistralai import Mistral +from e2b_code_interpreter import Sandbox + +# Create Mistral client +client = Mistral(api_key=os.environ["MISTRAL_API_KEY"]) +model = "mistral-large-latest" +messages = [ + { + "role": "user", + "content": "Calculate how many r's are in the word 'strawberry'" + } +] + +# Define the tools +tools = [{ + "type": "function", + "function": { + "name": "execute_python", + "description": "Execute python code in a Jupyter notebook cell and return result", + "parameters": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The python code to execute in a single cell" + } + }, + "required": ["code"] + } + } +}] + +# Send the prompt to the model +response = client.chat.complete( + model=model, + messages=messages, + tools=tools +) + +# Append the response message to the messages list +response_message = response.choices[0].message +messages.append(response_message) + +# Execute the tool if it's called by the model +if response_message.tool_calls: + for tool_call in response_message.tool_calls: + if tool_call.function.name == "execute_python": + # Create a sandbox and execute the code + with Sandbox.create() as sandbox: + code = json.loads(tool_call.function.arguments)['code'] + execution = sandbox.run_code(code) + result = execution.text + + # Send the result back to the model + messages.append({ + "role": "tool", + "name": "execute_python", + "content": result, + "tool_call_id": tool_call.id, + }) + +# Generate the final response +final_response = client.chat.complete( + model=model, + messages=messages, +) + +print(final_response.choices[0].message.content) +``` + + +--- + +## Groq + +```python Python + +# pip install groq e2b-code-interpreter +import os +from groq import Groq +from e2b_code_interpreter import Sandbox + +api_key = os.environ["GROQ_API_KEY"] + +# Create Groq client +client = Groq(api_key=api_key) +system_prompt = "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." +prompt = "Calculate how many r's are in the word 'strawberry.'" + +# Send the prompt to the model +response = client.chat.completions.create( + model="llama3-70b-8192", + messages=[ + {"role": "system", "content": system_prompt}, + {"role": "user", "content": prompt}, + ] +) + +# Extract the code from the response +code = response.choices[0].message.content + +# Execute code in E2B Sandbox +with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + result = execution.text + +print(result) + +``` + + +--- + +## Vercel AI SDK +Vercel's [AI SDK](https://sdk.vercel.ai) offers support for multiple different LLM providers through a unified JavaScript interface that's easy to use. + +### Simple + + +```js JavaScript & TypeScript +// npm install ai @ai-sdk/openai @e2b/code-interpreter +import { openai } from '@ai-sdk/openai' +import { generateText } from 'ai' +import { Sandbox } from '@e2b/code-interpreter' + +// Create OpenAI client +const model = openai('gpt-4o') +const system = "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." +const prompt = "Calculate how many r's are in the word 'strawberry'" + +// Generate code with OpenAI +const { text: code } = await generateText({ + model, + system, + prompt +}) + +// Run the code in E2B Sandbox +const sandbox = await Sandbox.create() +const { text, results, logs, error } = await sandbox.runCode(code) + +console.log(text) +``` + + +### Function calling + + +```js JavaScript & TypeScript +// npm install ai @ai-sdk/openai zod @e2b/code-interpreter +import { openai } from '@ai-sdk/openai' +import { generateText } from 'ai' +import z from 'zod' +import { Sandbox } from '@e2b/code-interpreter' + +// Create OpenAI client +const model = openai('gpt-4o') + +const prompt = "Calculate how many r's are in the word 'strawberry'" + +// Generate text with OpenAI +const { text } = await generateText({ + model, + prompt, + tools: { + // Define a tool that runs code in a sandbox + execute_python: { + description: 'Execute python code in a Jupyter notebook cell and return result', + parameters: z.object({ + code: z.string().describe('The python code to execute in a single cell'), + }), + execute: async ({ code }) => { + // Create a sandbox, execute LLM-generated code, and return the result + const sandbox = await Sandbox.create() + const { text, results, logs, error } = await sandbox.runCode(code) + return results + }, + }, + }, + // This is required to feed the tool call result back to the LLM + maxSteps: 2 +}) + +console.log(text) +``` + + +--- + +## CrewAI +[CrewAI](https://crewai.com/) is a platform for building AI agents. + + +```python Python +# pip install crewai e2b-code-interpreter +from crewai.tools import tool +from crewai import Agent, Task, Crew, LLM +from e2b_code_interpreter import Sandbox + +# Update tool definition using the decorator +@tool("Python Interpreter") +def execute_python(code: str) -> str: + """ + Execute Python code and return the results. + """ + with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + return execution.text + +# Define the agent +python_executor = Agent( + role='Python Executor', + goal='Execute Python code and return the results', + backstory='You are an expert Python programmer capable of executing code and returning results.', + tools=[execute_python], + llm=LLM(model="gpt-4o") +) + +# Define the task +execute_task = Task( + description="Calculate how many r's are in the word 'strawberry'", + agent=python_executor, + expected_output="The number of r's in the word 'strawberry'" +) + +# Create the crew +code_execution_crew = Crew( + agents=[python_executor], + tasks=[execute_task], + verbose=True, +) + +# Run the crew +result = code_execution_crew.kickoff() +print(result) +``` + + +--- + +## LangChain +[LangChain](https://langchain.com/) offers support multiple different LLM providers. + +### Simple + + +```python Python +# pip install langchain langchain-openai e2b-code-interpreter +from langchain_openai import ChatOpenAI +from langchain_core.prompts import ChatPromptTemplate +from langchain_core.output_parsers import StrOutputParser +from e2b_code_interpreter import Sandbox + +system_prompt = "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." +prompt = "Calculate how many r's are in the word 'strawberry'" + +# Create LangChain components +llm = ChatOpenAI(model="gpt-4o") +prompt_template = ChatPromptTemplate.from_messages([ + ("system", system_prompt), + ("human", "{input}") +]) + +output_parser = StrOutputParser() + +# Create the chain +chain = prompt_template | llm | output_parser + +# Run the chain +code = chain.invoke({"input": prompt}) + +# Execute code in E2B Sandbox +with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + result = execution.text + +print(result) +``` + + +### Agent + + +```python Python +# pip install langchain langchain-openai e2b-code-interpreter +from langchain_core.prompts import ChatPromptTemplate +from langchain_core.tools import tool +from langchain.agents import create_tool_calling_agent, AgentExecutor +from langchain_openai import ChatOpenAI +from e2b_code_interpreter import Sandbox + +system_prompt = "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." +prompt = "Calculate how many r's are in the word 'strawberry'" + +# Define the tool +@tool +def execute_python(code: str): + """ + Execute python code in a Jupyter notebook. + """ + with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + return execution.text + +# Define LangChain components +prompt_template = ChatPromptTemplate.from_messages([ + ("system", system_prompt), + ("human", "{input}"), + ("placeholder", "{agent_scratchpad}"), +]) + +tools = [execute_python] +llm = ChatOpenAI(model="gpt-4o", temperature=0) + +agent = create_tool_calling_agent(llm, tools, prompt_template) +agent_executor = AgentExecutor(agent=agent, tools=tools, verbose=True) + +# Run the agent +agent_executor.invoke({"input": prompt}) +``` + + +### Function calling + + +```python Python +# pip install langchain langchain-openai e2b-code-interpreter +from langchain_openai import ChatOpenAI +from langchain.tools import Tool +from langchain.schema import HumanMessage, AIMessage, FunctionMessage +from e2b_code_interpreter import Sandbox + +def execute_python(code: str): + with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + return execution.text + +# Define a tool that uses the E2B Sandbox +e2b_sandbox_tool = Tool( + name="execute_python", + func=execute_python, + description="Execute python code in a Jupyter notebook cell and return result" +) + +# Initialize the language model and bind the tool +llm = ChatOpenAI(model="gpt-4o").bind_tools([e2b_sandbox_tool]) + +# Define the messages +messages = [ + HumanMessage(content="Calculate how many 'r's are in the word 'strawberry'.") +] + +# Run the model with a prompt +result = llm.invoke(messages) +messages.append(AIMessage(content=result.content)) + +# Check if the model called the tool +if result.additional_kwargs.get('tool_calls'): + tool_call = result.additional_kwargs['tool_calls'][0] + if tool_call['function']['name'] == "execute_python": + code = tool_call['function']['arguments'] + execution_result = execute_python(code) + + # Send the result back to the model + messages.append( + FunctionMessage(name="execute_python", content=execution_result) + ) + +final_result = llm.invoke(messages) +print(final_result.content) +``` + + +--- + +## LlamaIndex +[LlamaIndex](https://www.llamaindex.ai/) offers support multiple different LLM providers. + +```python Python +# pip install llama-index e2b-code-interpreter +from llama_index.core.tools import FunctionTool +from llama_index.llms.openai import OpenAI +from llama_index.core.agent import ReActAgent +from e2b_code_interpreter import Sandbox + +# Define the tool +def execute_python(code: str): + with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + return execution.text + +e2b_sandbox_tool = FunctionTool.from_defaults( + name="execute_python", + description="Execute python code in a Jupyter notebook cell and return result", + fn=execute_python +) + +# Initialize LLM +llm = OpenAI(model="gpt-4o") + +# Initialize ReAct agent +agent = ReActAgent.from_tools([e2b_sandbox_tool], llm=llm, verbose=True) +agent.chat("Calculate how many r's are in the word 'strawberry'") +``` + + +## Ollama + + +```python Python +# pip install ollama +import ollama +from e2b_code_interpreter import Sandbox + +# Send the prompt to the model +response = ollama.chat( + model="llama3.2", + messages=[{ + "role": "system", + "content": "You are a helpful assistant that can execute python code in a Jupyter notebook. Only respond with the code to be executed and nothing else. Strip backticks in code blocks." + }, + { + "role": "user", + "content": "Calculate how many r's are in the word 'strawberry'" + } +]) + +# Extract the code from the response +code = response['message']['content'] + +# Execute code in E2B Sandbox +with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + result = execution.logs.stdout + +print(result) +``` + + +--- + +## Hugging Face + +Hugging Face offers support for serverless inference for models on their model hub with [Hugging Face's Inference API](https://huggingface.co/docs/inference-providers/en/index). + + +Note that not every model on Hugging Face has native support for tool use and function calling. + + + +```python Python +from huggingface_hub import InferenceClient +from e2b_code_interpreter import Sandbox +import re + +# Not all models are capable of direct tools use - we need to extract the code block manually and prompting the LLM to generate the code. +def match_code_block(llm_response): + pattern = re.compile(r'```python Python\n(.*?)\n```', re.DOTALL) # Match everything in between ```python and ``` + match = pattern.search(llm_response) + if match: + code = match.group(1) + print(code) + return code + return "" + + +system_prompt = """You are a helpful coding assistant that can execute python code in a Jupyter notebook. You are given tasks to complete and you run Python code to solve them. +Generally, you follow these rules: +- ALWAYS FORMAT YOUR RESPONSE IN MARKDOWN +- ALWAYS RESPOND ONLY WITH CODE IN CODE BLOCK LIKE THIS: +\`\`\`python +{code} +\`\`\` +""" +prompt = "Calculate how many r's are in the word 'strawberry.'" + +# Initialize the client +client = InferenceClient( + provider="hf-inference", + api_key="HF_INFERENCE_API_KEY" +) + +completion = client.chat.completions.create( + model="Qwen/Qwen3-235B-A22B", # Or use any other model from Hugging Face + messages=[ + {"role": "system", "content": system_prompt}, + {"role": "user", "content": prompt}, + ] +) + +content = completion.choices[0].message.content +code = match_code_block(content) + +with Sandbox.create() as sandbox: + execution = sandbox.run_code(code) + print(execution) +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx new file mode 100644 index 0000000000..60a264429e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx @@ -0,0 +1,69 @@ +--- +title: Running your first Sandbox +description: This guide will show you how to start your first E2B Sandbox. +--- + + + +Every new E2B account get $100 in credits. You can sign up [here](https://e2b.dev/auth/sign-up). + + +1. Navigate to the E2B Dashboard. +2. Copy your API key. +3. Paste your E2B API key into your .env file. + +```bash .env +E2B_API_KEY=e2b_*** +``` + + +Install the E2B SDK to your project by running the following command in your terminal. + +```javascript JavaScript & TypeScript +npm i @e2b/code-interpreter dotenv +``` +```python Python +pip install e2b-code-interpreter python-dotenv +``` + + + +We'll write the minimal code for starting Sandbox, executing Python inside it and listing all files inside the root directory. + +```javascript index.ts +import 'dotenv/config' +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() // By default the sandbox is alive for 5 minutes +const execution = await sbx.runCode('print("hello world")') // Execute Python inside the sandbox +console.log(execution.logs) + +const files = await sbx.files.list('/') +console.log(files) +``` +```python main.py +from dotenv import load_dotenv +load_dotenv() +from e2b_code_interpreter import Sandbox + +sbx = Sandbox() # By default the sandbox is alive for 5 minutes +execution = sbx.run_code("print('hello world')") # Execute Python inside the sandbox +print(execution.logs) + +files = sbx.files.list("/") +print(files) +``` + + + +Run the code with the following command: + +```bash JavaScript & TypeScript +npx tsx ./index.ts +``` +```bash Python +python main.py +``` + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/quickstart/install-custom-packages/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/quickstart/install-custom-packages/index.mdx new file mode 100644 index 0000000000..26b63225e8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/quickstart/install-custom-packages/index.mdx @@ -0,0 +1,189 @@ +--- +title: "Install custom packages" +--- + +There are two ways to install custom packages in the E2B Sandbox. + +1. [Create custom sandbox with preinstalled packages](#create-a-custom-sandbox). +2. [Install packages during the sandbox runtime](#install-packages-during-the-sandbox-runtime). + +--- + +## Create a custom sandbox + +Use this option if you know beforehand what packages you need in the sandbox. + +Prerequisites: +- E2B CLI +- Docker running + + +Custom sandbox template is a Docker image that we automatically convert to a sandbox that you can then start with our SDK. + + + +### 1. Install E2B CLI + +**Using Homebrew (on macOS)** + + +```bash Terminal +brew install e2b +``` + + +**Using NPM** + + +```bash Terminal +npm i -g @e2b/cli +``` + + +### 2. Login to E2B CLI +Before you can create a custom sandbox, you need to login to E2B CLI. + +```bash Terminal +e2b auth login +``` + + +### 2. Initialize a sandbox template + +```bash Terminal +e2b template init +``` + + +### 3. Specify the packages you need in `e2b.Dockerfile` +Edit the E2B Dockerfile to install the packages you need. + + +You need to use the `e2bdev/code-interpreter:latest` base image. + + + +```bash e2b.Dockerfile +FROM e2bdev/code-interpreter:latest + +RUN pip install cowsay +RUN npm install cowsay +``` + + +### 4. Build the sandbox template +Run the following command to build the sandbox template. + +```bash Terminal +e2b template build -c "/root/.jupyter/start-up.sh" +``` + + +This will take a while, as it convert the Docker image to a sandbox which is a small VM. +At the end of the process you will see the sandbox ID like this: +``` +Running postprocessing. It can take up to few minutes. + +Postprocessing finished. + +✅ Building sandbox template YOUR_TEMPLATE_ID finished. +``` + +### 5. Start your custom sandbox +Now you can pass the template ID to the SDK to start your custom sandbox. + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = Sandbox.create({ + template: 'YOUR_TEMPLATE_ID', +}) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create(template='YOUR_TEMPLATE_ID') +``` + + +--- + + +## Install packages during the sandbox runtime +Use this option if don't know beforehand what packages you need in the sandbox. You can install packages with the package manager of your choice. + + +The packages installed during the runtime are available only in the running sandbox instance. +When you start a new sandbox instance, the packages are not be available. + + +### 1. Install Python packages with PIP + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = Sandbox.create() +sbx.commands.run('pip install cowsay') // This will install the cowsay package +sbx.runCode(` + import cowsay + cowsay.cow("Hello, world!") +`) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +sbx.commands.run("pip install cowsay") # This will install the cowsay package +sbx.run_code(""" + import cowsay + cowsay.cow("Hello, world!") +""") +``` + + + +### 2. Install Node.js packages with NPM + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = Sandbox.create() +sbx.commands.run('npm install cowsay') // This will install the cowsay package +sbx.runCode(` + const cowsay = require('cowsay') + console.log(cowsay.say({ text: 'Hello, world!' })) +`, { language: 'javascript' }) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +sbx.commands.run("npm install cowsay") # This will install the cowsay package +sbx.run_code(""" + import { say } from 'cowsay' + console.log(say('Hello, world!')) +""", language="javascript") +``` + + + +### 3. Install packages with package manager of your choice +Since E2B Sandboxes are Debian based machines, you can use any package manager supported by Debian. +You just need to make sure that the package manager is already installed in the sandbox. + +For example, to install `curl` and `git`, you can use the following commands: + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = Sandbox.create() +await sbx.commands.run('apt-get update && apt-get install -y curl git') +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +sbx.commands.run("apt-get update && apt-get install -y curl git") +``` + \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/quickstart/upload-download-files/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/quickstart/upload-download-files/index.mdx new file mode 100644 index 0000000000..5c4345858c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/quickstart/upload-download-files/index.mdx @@ -0,0 +1,150 @@ +--- +title: "Upload & downloads files" +--- + +E2B Sandbox allows you to upload and downloads file to and from the Sandbox. + +An alternative way to get your data to the sandbox is to create a [custom sandbox template](/sandbox-template). + + +## Upload file + +```ts JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Read local file relative to the current working directory +const content = fs.readFileSync('local/file') + +const sbx = await Sandbox.create() +// Upload file to the sandbox to absolute path '/home/user/my-file' +await sbx.files.write('/home/user/my-file', content) +``` + +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() + +# Read local file relative to the current working directory +with open("local/file", "rb") as file: + # Upload file to the sandbox to absolute path '/home/user/my-file' + sbx.files.write("/home/user/my-file", file) +``` + + + +## Upload multiple files +Currently, if you want to upload multiple files, you need to upload each one of the separately. +We're working on a better solution. + + +```ts JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Read local file relative to the current working directory +const fileA = fs.readFileSync('local/file/a') +const fileB = fs.readFileSync('local/file/b') + +const sbx = await Sandbox.create() +// Upload file A to the sandbox to absolute path '/home/user/my-file-a' +await sbx.files.write('/home/user/my-file-a', fileA) +// Upload file B to the sandbox to absolute path '/home/user/my-file-b' +await sbx.files.write('/home/user/my-file-b', fileB) +``` + +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() + +# Read local file relative to the current working directory +with open("local/file/a", "rb") as file: + # Upload file to the sandbox to absolute path '/home/user/my-file-a' + sbx.files.write("/home/user/my-file-a", file) + +with open("local/file/b", "rb") as file: + # Upload file to the sandbox to absolute path '/home/user/my-file-b' + sbx.files.write("/home/user/my-file-b", file) +``` + + + +## Upload directory +We currently don't support an easy way to upload a whole directory. +You need to upload each file separately. + +We're working on a better solution. + +--- + +## Download file +To download a file, you need to first get the file's content and then write it to a local file. + + +```ts JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +// Download file from the sandbox to absolute path '/home/user/my-file' +const content = await sbx.files.read('/home/user/my-file') +// Write file to local path relative to the current working directory +fs.writeFileSync('local/file', content) +``` + +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +# Download file from the sandbox to absolute path '/home/user/my-file' +content = sbx.files.read('/home/user/my-file') +# Write file to local path relative to the current working directory +with open('local/file', 'w') as file: + file.write(content) +``` + + +## Download multiple files +To download multiple files, you need to download each one of them separately from the sandbox. + +We're working on a better solution. + + + +```ts JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +// Download file A from the sandbox by absolute path '/home/user/my-file-a' +const contentA = await sbx.files.read('/home/user/my-file-a') +// Write file A to local path relative to the current working directory +fs.writeFileSync('local/file/a', contentA) + +// Download file B from the sandbox by absolute path '/home/user/my-file-b' +const contentB = await sbx.files.read('/home/user/my-file-b') +// Write file B to local path relative to the current working directory +fs.writeFileSync('local/file/b', contentB) +``` + +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +# Download file A from the sandbox by absolute path '/home/user/my-file-a' +contentA = sbx.files.read('/home/user/my-file-a') +# Write file A to local path relative to the current working directory +with open('local/file/a', 'w') as file: + file.write(contentA) + +# Download file B from the sandbox by absolute path '/home/user/my-file-b' +contentB = sbx.files.read('/home/user/my-file-b') +# Write file B to local path relative to the current working directory +with open('local/file/b', 'w') as file: + file.write(contentB) +``` + + +## Download directory +We currently don't support an easy way to download a whole directory. +You need to download each file separately. + +We're working on a better solution. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/customize-cpu-ram/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/customize-cpu-ram/index.mdx new file mode 100644 index 0000000000..dc669f6a05 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/customize-cpu-ram/index.mdx @@ -0,0 +1,18 @@ +--- +title: "Customize sandbox CPU & RAM" +sidebarTitle: Customize CPU & RAM +--- + +You can customize the CPU and RAM of your sandbox template via E2B CLI. + +You'll need to create a sandbox [template first](/sandbox-template). + +During the build step, you can specify the CPU and RAM of your sandbox template. + +The following command will create a sandbox template with 2 CPUs and 2GB of RAM. + + +```bash Terminal +e2b template build -c "/root/.jupyter/start-up.sh" --cpu-count 2 --memory-mb 2048 +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx new file mode 100644 index 0000000000..1da2ce4ec3 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx @@ -0,0 +1,138 @@ +--- +title: "Sandbox templates" +sidebarTitle: Sandbox customization +--- + +Sandbox templates allow you to customize the sandbox environment to your needs. + +To create a sandbox template, you specify the `e2b.Dockerfile`. We then take this Dockerfile and create a new sandbox template from it and give you back a template ID. + +You can then use this template ID to create a new sandbox with the SDK based on the template you created. + +## How to create custom sandbox + +**Steps** +1. [Install E2B CLI](#1-install-e2b-cli) +1. [Initialize sandbox template](#2-initialize-sandbox-template) +1. [Customize `e2b.Dockerfile`](#3-customize-e2b-dockerfile) +1. [Build your sandbox template](#4-build-your-sandbox-template) +1. [Start your custom sandbox](#5-start-your-custom-sandbox) + + +### 1. Install E2B CLI + +**Using Homebrew (on macOS)** + + + ```bash Homebrew + brew install e2b + ``` + + +**Using NPM** + + + ```bash NPM + npm i -g @e2b/cli + ``` + + +### 2. Initialize sandbox template +The following command will create a basic `e2b.Dockerfile` in the current directory. + + + ```bash bash + e2b template init + ``` + + +### 3. Customize `e2b.Dockerfile` +Now you can customize your sandbox template by editing the `e2b.Dockerfile` file. + + ```bash e2b.Dockerfile + # Make sure to use this base image + FROM e2bdev/code-interpreter:latest # $HighlightLine + + # Install some Python packages + RUN pip install cowsay # $HighlightLine + ``` + + + + Only [Debian-based](https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based) images + (e.g., Debian, Ubuntu, or [E2B images](https://hub.docker.com/u/e2bdev)) are supported. + + +### 4. Build your sandbox template +Now you can build your sandbox template. We'll use Docker and the E2B CLI. +What is going to happen is that E2B CLI will call Docker to build the image and then push it to the E2B cloud. +Then we convert the Docker image to a micro VM that can be then launched as a sandbox with our SDK. + + + ```bash bash + e2b template build -c "/root/.jupyter/start-up.sh" + ``` + + +This process will take a moment. In the end, you'll see your template ID that you'll need to use to create a sandbox with the SDK. + +### 5. Start your custom sandbox +Now you can use the template ID to create a sandbox with the SDK. + + + ```javascript JavaScript & TypeScript highlight={4,6} + import { Sandbox } from '@e2b/code-interpreter' + + // Your template ID from the previous step + const templateID = 'id-of-your-template' // $HighlightLine + // Pass the template ID to the `Sandbox.create` method + const sandbox = await Sandbox.create(templateID) // $HighlightLine + + // The template installed cowsay, so we can use it + const execution = await sandbox.runCode(` + import cowsay + cowsay.say('Hello from E2B!') + `) + + console.log(execution.stdout) + ``` + ```python Python highlight={4,6} + from e2b_code_interpreter import Sandbox + + # Your template ID from the previous step + template_id = 'id-of-your-template' # $HighlightLine + # Pass the template ID to the `Sandbox.create` method + sandbox = Sandbox.create(template_id) # $HighlightLine + + # The template installed cowsay, so we can use it + execution = sandbox.run_code(""" + import cowsay + cowsay.say('Hello from E2B!') + """) + + print(execution.stdout) + ``` + + +## How it works +Every time you are building a sandbox template, we create a container based on the [`e2b.Dockerfile`](/sandbox-template#3-customize-e2b-dockerfile) file you create in the process. +We extract the container's filesystem, do provisioning and configuration (e.g. installing required dependencies), and start a sandbox. + +Then, these steps happen: + + 1. We take the running sandbox. + 2. (Only if you specified the [start command](/sandbox-template/start-cmd), otherwise this step is skipped) Execute the start command. + 3. Wait for readiness (by default 20 seconds if start command is specified, otherwise immediately ready). Readiness check can be configured using [ready command](/sandbox-template/ready-cmd). + 4. Snapshot the sandbox and make it ready for you to spawn it with the SDK. + +We call this sandbox snapshot a _sandbox template_. + + + **Sandbox Snapshot** + + Snapshots are saved running sandboxes. We serialize and save the whole sandbox's filesystem together with all the + running processes in a way that can be loaded later. + + This allows us to load the sandbox in a few hundred milliseconds any time later with all the processes already running + and the filesystem exactly as it was. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx new file mode 100644 index 0000000000..6d4b89b7ab --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx @@ -0,0 +1,51 @@ +--- +title: "Ready Command" +sidebarTitle: Ready command +--- + +The ready command allows you to specify a command that will determine **template sandbox** readiness before a [snapshot](/sandbox-template#how-it-works) is created. +It is executed in an infinite loop until it returns a successful **exit code 0**. +This way you can control how long should we wait for the [start command](/sandbox-template/start-cmd) or any system state. + + +## How to add ready command + +When you are building a sandbox template you can specify the ready command by using the [`--ready-cmd`](/sdk-reference/cli/v1.5.0/template#e2b-template-build) option: + +```bash +e2b template build --ready-cmd "" +``` + +### Sandbox template config +You can specify the ready command inside the `e2b.toml` in the same directory where you run `e2b template build`. + + ```toml + # This is a config for E2B sandbox template + template_id = "1wdqsf9le9gk21ztb4mo" + dockerfile = "e2b.Dockerfile" + template_name = "my-agent-sandbox" + ready_cmd = "" # $HighlightLine + ``` + + +## Default values +By default, the ready command is set to `sleep 0`, which means the sandbox template will be ready immediatelly. +If the [start command](/sandbox-template/start-cmd) is defined, the default is set to `sleep 20`, which means that the template sandbox will wait for 20 seconds before taking the snapshot. + +## Examples +Here are some examples of the ready command you can use. + +### Wait for URL to return 200 status code +```bash +ready_cmd = 'curl -s -o /dev/null -w "%{http_code}" http://localhost:3000 | grep -q "200"' +``` + +### Wait for a specific process to start +```bash +ready_cmd = 'pgrep my-process-name > /dev/null' +``` + +### Wait for a file to exist +```bash +ready_cmd = '[ -f /tmp/ready.flag ]' +``` \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx new file mode 100644 index 0000000000..fd7893f692 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx @@ -0,0 +1,47 @@ +--- +title: "Start Command" +sidebarTitle: Start command +--- + +The start command allows you to specify a command that will be **already running** when you spawn your custom sandbox. +This way, you can for example have running servers or seeded databases inside the sandbox that are already fully ready when you spawn the sandbox using the SDK and with zero waiting time for your users during the runtime. + +The idea behind the start command feature is to lower the wait times for your users and have everything ready for your users when you spawn your sandbox. + +You can see how it works [here](/sandbox-template#how-it-works). + +## How to add start command + +When you are building a sandbox template you can specify the start command by using the [`-c`](/sdk-reference/cli/v1.0.9/template#e2b-template-build) option: + +```bash +e2b template build -c "" +``` + +When you spawn the custom sandbox you built, the start command will be already running if there was no error when we tried to execute it. + +### Sandbox template config +You can specify the start command also inside the `e2b.toml` in the same directory where you run `e2b template build`. + + ```toml highlight={5} + # This is a config for E2B sandbox template + template_id = "1wdqsf9le9gk21ztb4mo" + dockerfile = "e2b.Dockerfile" + template_name = "my-agent-sandbox" + start_cmd = "" # $HighlightLine + ``` + + + +## Logs +You can retrieve the start command's logs using the CLI: + + +```bash bash +e2b sandbox logs +``` + + + +These logs include logs from the start command during the build phase. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect-bucket/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect-bucket/index.mdx new file mode 100644 index 0000000000..b162c7b90d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect-bucket/index.mdx @@ -0,0 +1,166 @@ +--- +title: "Connecting storage bucket to the sandbox" +sidebarTitle: Connecting storage bucket +--- + +To connect a bucket for storing data from the sandbox, we will use the FUSE file system to mount the bucket to the sandbox. + +You will need to create a custom sandbox template with the FUSE file system installed. The guide for building a custom sandbox template can be found [here](/sandbox-template). + +## Google Cloud Storage +### Prerequisites + +To use Google Cloud Storage, you'll need a bucket and a service account. You can create a service account [here](https://console.cloud.google.com/iam-admin/serviceaccounts) and a bucket [here](https://console.cloud.google.com/storage). + +If you want to write to the bucket, make sure the service account has the `Storage Object User` role for this bucket. + +You can find a guide on creating a service account key [here](https://cloud.google.com/iam/docs/keys-create-delete#iam-service-account-keys-create-console). + +### Mounting the bucket + +To use the Google Cloud Storage we need to install the `gcsfuse` package. There's simple `Dockerfile` that can be used to create a container with the `gcsfuse` installed. + +```docker +FROM e2bdev/code-interpreter:latest + +RUN apt-get update && apt-get install -y gnupg lsb-release wget + +RUN lsb_release -c -s > /tmp/lsb_release +RUN GCSFUSE_REPO=$(cat /tmp/lsb_release) && echo "deb https://packages.cloud.google.com/apt gcsfuse-$GCSFUSE_REPO main" | tee /etc/apt/sources.list.d/gcsfuse.list +RUN wget -O - https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - + +RUN apt-get update && apt-get install -y gcsfuse + +``` + +The bucket is mounted during the sandbox runtime using the `gcsfuse` command. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create('') +await sandbox.files.makeDir('/home/user/bucket') +await sandbox.files.write('key.json', '') + +await sandbox.commands.run('sudo gcsfuse --key-file /home/user/key.json /home/user/bucket') +``` + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create("") +sandbox.files.make_dir("/home/user/bucket") +sandbox.files.write("key.json", "") + +output = sandbox.commands.run( + "sudo gcsfuse --key-file /home/user/key.json /home/user/bucket" +) +``` + + +### Flags + +The complete list of flags is available [here](https://cloud.google.com/storage/docs/gcsfuse-cli#options). + +### Allow the default user to access the files + +To allow the default user to access the files, we can use the following flags: + +``` +-o allow_other -file-mode=777 -dir-mode=777 +``` + +## Amazon S3 + +To use Amazon S3, we can use the `s3fs` package. The `Dockerfile` setup is similar to that of Google Cloud Storage. + +```docker +FROM ubuntu:latest + +RUN apt-get update && apt-get install s3fs +``` + +Similar to Google Cloud Storage, the bucket is mounted during the runtime of the sandbox. The `s3fs` command is used to mount the bucket to the sandbox. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create('') +await sandbox.files.makeDir('/home/user/bucket') + +// Create a file with the credentials +// If you use another path for the credentials you need to add the path in the command s3fs command +await sandbox.files.write('/root/.passwd-s3fs', ':') +await sandbox.commands.run('sudo chmod 600 /root/.passwd-s3fs') + +await sandbox.commands.run('sudo s3fs /home/user/bucket') +``` + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create("") +sandbox.files.make_dir("/home/user/bucket") + +# Create a file with the credentials +# If you use another path for the credentials you need to add the path in the command s3fs command +sandbox.files.write("/root/.passwd-s3fs", ":") +sandbox.commands.run("sudo chmod 600 /root/.passwd-s3fs") + +sandbox.commands.run("sudo s3fs /home/user/bucket") +``` + + +### Flags + +The complete list of flags is available [here](https://manpages.ubuntu.com/manpages/xenial/man1/s3fs.1.html). + +### Allow the default user to access the files + +To allow the default user to access the files, add the following flag: + +``` +-o allow_other +``` + +## Cloudflare R2 + +For Cloudflare R2, we can use a setup very similar to S3. The `Dockerfile` remains the same as for S3. However, the mounting differs slightly; we need to specify the endpoint for R2. + + +```js JavaScript & TypeScript +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create({ template: '' }) +await sandbox.files.makeDir('/home/user/bucket') + +// Create a file with the R2 credentials +// If you use another path for the credentials you need to add the path in the command s3fs command +await sandbox.files.write('/root/.passwd-s3fs', ':') +await sandbox.commands.run('sudo chmod 600 /root/.passwd-s3fs') + +await sandbox.commands.run('sudo s3fs -o url=https://.r2.cloudflarestorage.com /home/user/bucket') +``` + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create("") +sandbox.files.make_dir("/home/user/bucket") + +# Create a file with the R2 credentials +# If you use another path for the credentials you need to add the path in the command s3fs command +sandbox.files.write("/root/.passwd-s3fs", ":") +sandbox.commands.run("sudo chmod 600 /root/.passwd-s3fs") + +sandbox.commands.run( + "sudo s3fs -o url=https://.r2.cloudflarestorage.com /home/user/bucket" +) +``` + + +### Flags + +It's the same as for S3. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx new file mode 100644 index 0000000000..48705f9c26 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx @@ -0,0 +1,90 @@ +--- +title: "Connect to running sandbox" +--- + +If you have a running sandbox, you can connect to it using the `Sandbox.connect()` method and then start controlling it with our SDK. + +This is useful if you want to, for example, reuse the same sandbox instance for the same user after a short period of inactivity. + +## 1. Get the sandbox ID +To connect to a running sandbox, you first need to retrieve its ID. You can do this by calling the `Sandbox.list()` method. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' +const sbx = await Sandbox.create() + +// Get all running sandboxes +const paginator = await Sandbox.list({ + query: { state: ['running'] }, // $HighlightLine +}) + +const runningSandboxes = await paginator.nextItems() +if (runningSandboxes.length === 0) { + throw new Error('No running sandboxes found') +} + +// Get the ID of the sandbox you want to connect to +const sandboxId = runningSandboxes[0].sandboxId +``` + +```python Python +from e2b_code_interpreter import Sandbox + +# Get all running sandboxes +paginator = Sandbox.list() # $HighlightLine + +# Get the ID of the sandbox you want to connect to +running_sandboxes = paginator.next_items() +if len(running_sandboxes) == 0: + raise Exception("No running sandboxes found") + +# Get the ID of the sandbox you want to connect to +sandbox_id = running_sandboxes[0].sandbox_id + +``` + + +## 2. Connect to the sandbox + +Now that you have the sandbox ID, you can connect to the sandbox using the `Sandbox.connect()` method. + + +```js JavaScript & TypeScript +import { Sandbox } from "@e2b/code-interpreter" + +// Get all running sandboxes +const runningSandboxes = await Sandbox.list() + +if (runningSandboxes.length === 0) { + throw new Error("No running sandboxes found") +} + +// Get the ID of the sandbox you want to connect to +const sandboxId = runningSandboxes[0].sandboxId + +// Connect to the sandbox +const sandbox = await Sandbox.connect(sandboxId) // $HighlightLine +// Now you can use the sandbox as usual +// ... + +``` +```python Python +from e2b_code_interpreter import Sandbox + +# Get all running sandboxes +running_sandboxes = Sandbox.list() + +# Get the ID of the sandbox you want to connect to +if len(running_sandboxes) == 0: + raise Exception("No running sandboxes found") + +sandbox_id = running_sandboxes[0].sandbox_id + +# Connect to the sandbox +sandbox = Sandbox.connect(sandbox_id) # $HighlightLine +# Now you can use the sandbox as usual +# ... + +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx new file mode 100644 index 0000000000..8c6b0c9f62 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx @@ -0,0 +1,123 @@ +--- +title: "Environment variables" +--- + +This page covers how to set and use environment variables in a sandbox, and default environment variables inside the sandbox. + +## Default environment variables +### Knowing if you are inside a sandbox + +Sometimes it's useful to know if the code is running inside a sandbox. Upon creating a sandbox, useful sandbox metadata is set as environment variables for commands: +- `E2B_SANDBOX` is set to `true` for processes to know if they are inside our VM. +- `E2B_SANDBOX_ID` to know the ID of the sandbox. +- `E2B_TEAM_ID` to know the team ID that created the sandbox. +- `E2B_TEMPLATE_ID` to know what template was used for the current sandbox. + +You can try it out by running the following code in the sandbox: + + +```js JavaScript & TypeScript +const sandbox = await Sandbox.create() +const result = await sandbox.commands.run('echo $E2B_SANDBOX_ID') +``` +```python Python +sandbox = Sandbox.create() +result = sandbox.commands.run("echo $E2B_SANDBOX_ID") +``` + + + +These default environment variables are only accessible via the SDK, when using the CLI you can find them in the form of dot files in the `/run/e2b/` dir: +```sh +user@e2b:~$ ls -a /run/e2b/ +.E2B_SANDBOX .E2B_SANDBOX_ID .E2B_TEAM_ID .E2B_TEMPLATE_ID +``` + + +--- + +## Setting environment variables +There are 3 ways to set environment variables in a sandbox: +1. [Global environment variables when creating the sandbox](/sandbox/environment-variables#1-global-environment-variables-when-creating-the-sandbox). +2. [When running code in the sandbox](/sandbox/environment-variables#2-setting-environment-variables-when-running-code). +3. [When running commands in the sandbox](/sandbox/environment-variables#3-setting-environment-variables-when-running-commands). + +### 1. Global environment variables +You can set global environment variables when creating a sandbox. + + +```js JavaScript & TypeScript highlight={4-6} +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create({ + envs: { // $HighlightLine + MY_VAR: 'my_value', // $HighlightLine + }, // $HighlightLine +}) +``` +```python Python highlight={4-6} +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create( + envs={ # $HighlightLine + 'MY_VAR': 'my_value', # $HighlightLine + }, # $HighlightLine +) +``` + + +### 2. Setting environment variables when running code +You can set environment variables for specific code execution call in the sandbox. + + +- These environment variables are scoped to the command but are not private in the OS. +- If you had a global environment variable with the same name, it will be overridden only for the command. + + + +```js JavaScript & TypeScript highlight={3-5} +const sandbox = await Sandbox.create() +const result = await sandbox.runCode('import os; print(os.environ.get("MY_VAR"))', { + envs: { // $HighlightLine + MY_VAR: 'my_value', // $HighlightLine + }, // $HighlightLine +}) +``` +```python Python highlight={4-6} +sandbox = Sandbox.create() +result = sandbox.run_code( + 'import os; print(os.environ.get("MY_VAR"))', + envs={ # $HighlightLine + 'MY_VAR': 'my_value' # $HighlightLine + } # $HighlightLine +) +``` + + +### 3. Setting environment variables when running commands +You can set environment variables for specific command execution in the sandbox. + + +- These environment variables are scoped to the command but are not private in the OS. +- If you had a global environment variable with the same name, it will be overridden only for the command. + + + +```js JavaScript & TypeScript highlight={3-5} +const sandbox = await Sandbox.create() +sandbox.commands.run('echo $MY_VAR', { + envs: { // $HighlightLine + MY_VAR: '123', // $HighlightLine + }, // $HighlightLine +}) +``` +```python Python highlight={4-6} +sandbox = Sandbox.create() +sandbox.commands.run( + 'echo $MY_VAR', + envs={ # $HighlightLine + 'MY_VAR': '123' # $HighlightLine + } # $HighlightLine +) +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx new file mode 100644 index 0000000000..3e5bd29692 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx @@ -0,0 +1,132 @@ +--- +title: "Sandbox lifecycle" +sidebarTitle: Lifecycle +--- + +When you start the sandbox, it stays alive for 5 minutes by default but you can change it by passing the `timeout` parameter. +After the time passes, the sandbox will be automatically shutdown. + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with and keep it running for 60 seconds. +// 🚨 Note: The units are milliseconds. +const sandbox = await Sandbox.create({ + timeoutMs: 60_000, // $HighlightLine +}) +``` +```python Python +from e2b_code_interpreter import Sandbox + +# Create sandbox with and keep it running for 60 seconds. +# 🚨 Note: The units are seconds. +sandbox = Sandbox.create( + timeout=60, # $HighlightLine +) +``` + + + +## Change sandbox timeout during runtime + +You can change the sandbox timeout when it's running by calling the the `setTimeout` method in JavaScript or `set_timeout` method in Python. + +When you call the set timeout method, the sandbox timeout will be reset to the new value that you specified. + +This can be useful if you want to extend the sandbox lifetime when it's already running. +You can for example start with a sandbox with 1 minute timeout and then periodically call set timout every time user interacts with it in your app. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with and keep it running for 60 seconds. +const sandbox = await Sandbox.create({ timeoutMs: 60_000 }) + +// Change the sandbox timeout to 30 seconds. +// 🚨 The new timeout will be 30 seconds from now. +await sandbox.setTimeout(30_000) +``` +```python Python +from e2b_code_interpreter import Sandbox + +# Create sandbox with and keep it running for 60 seconds. +sandbox = Sandbox.create(timeout=60) + +# Change the sandbox timeout to 30 seconds. +# 🚨 The new timeout will be 30 seconds from now. +sandbox.set_timeout(30) +``` + + +## Retrieve sandbox information + +You can retrieve sandbox information like sandbox ID, template, metadata, started at/end at date by calling the `getInfo` method in JavaScript or `get_info` method in Python. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with and keep it running for 60 seconds. +const sandbox = await Sandbox.create({ timeoutMs: 60_000 }) + +// Retrieve sandbox information. +const info = await sandbox.getInfo() + +console.log(info) + +// { +// "sandboxId": "iiny0783cype8gmoawzmx-ce30bc46", +// "templateId": "rki5dems9wqfm4r03t7g", +// "name": "base", +// "metadata": {}, +// "startedAt": "2025-03-24T15:37:58.076Z", +// "endAt": "2025-03-24T15:42:58.076Z" +// } +``` + +```python Python +from e2b_code_interpreter import Sandbox + +# Create sandbox with and keep it running for 60 seconds. +sandbox = Sandbox.create(timeout=60) + +# Retrieve sandbox information. +info = sandbox.get_info() + +print(info) + +# SandboxInfo(sandbox_id='ig6f1yt6idvxkxl562scj-419ff533', +# template_id='u7nqkmpn3jjf1tvftlsu', +# name='base', +# metadata={}, +# started_at=datetime.datetime(2025, 3, 24, 15, 42, 59, 255612, tzinfo=tzutc()), +# end_at=datetime.datetime(2025, 3, 24, 15, 47, 59, 255612, tzinfo=tzutc()) +# ) +``` + + +## Shutdown sandbox + +You can shutdown the sandbox any time even before the timeout is up by calling the `kill` method. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with and keep it running for 60 seconds. +const sandbox = await Sandbox.create({ timeoutMs: 60_000 }) + +// Shutdown the sandbox immediately. +await sandbox.kill() +``` +```python Python +from e2b_code_interpreter import Sandbox + +# Create sandbox with and keep it running for 60 seconds. +sandbox = Sandbox.create(timeout=60) + +# Shutdown the sandbox immediately. +sandbox.kill() +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx new file mode 100644 index 0000000000..691ae65484 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx @@ -0,0 +1,160 @@ +--- +title: "Internet access" +--- + +Every sandbox has access to the internet and can be reached by a public URL. + +## Controlling internet access + +You can control whether a sandbox has access to the internet by using the `allowInternetAccess` parameter when creating a sandbox. By default, internet access is enabled (`true`), but you can disable it for security-sensitive workloads. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with internet access enabled (default) +const sandbox = await Sandbox.create({ allowInternetAccess: true }) + +// Create sandbox without internet access +const isolatedSandbox = await Sandbox.create({ allowInternetAccess: false }) +``` +```python Python +from e2b_code_interpreter import Sandbox + +# Create sandbox with internet access enabled (default) +sandbox = Sandbox.create(allow_internet_access=True) + +# Create sandbox without internet access +isolated_sandbox = Sandbox.create(allow_internet_access=False) +``` + + +When internet access is disabled, the sandbox cannot make outbound network connections, which provides an additional layer of security for sensitive code execution. + +## Sandbox public URL +Every sandbox has a public URL that can be used to access running services inside the sandbox. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// You need to always pass a port number to get the host +const host = sandbox.getHost(3000) // $HighlightLine +console.log(`https://${host}`) +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# You need to always pass a port number to get the host +host = sandbox.get_host(3000) # $HighlightLine +print(f'https://{host}') +``` + + +The code above will print something like this: + + +```bash JavaScript & TypeScript +https://3000-i62mff4ahtrdfdkyn2esc-b0b684e9.e2b.dev +``` +```bash Python +https://3000-i62mff4ahtrdfdkyn2esc-b0b684e9.e2b.dev +``` + + +The first leftmost part of the host is the port number we passed to the method. + +## Connecting to a server running inside the sandbox +You can start a server inside the sandbox and connect to it using the approach above. + +In this example we will start a simple HTTP server that listens on port 3000 and responds with the content of the directory where the server is started. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() + +// Start a simple HTTP server inside the sandbox. +const process = await sandbox.commands.run('python -m http.server 3000', { background: true }) +const host = sandbox.getHost(3000) +const url = `https://${host}` +console.log('Server started at:', url) + +// Fetch data from the server inside the sandbox. +const response = await fetch(url); +const data = await response.text(); +console.log('Response from server inside sandbox:', data); + +// Kill the server process inside the sandbox. +await process.kill() +``` +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() + +# Start a simple HTTP server inside the sandbox. +process = sandbox.commands.run("python -m http.server 3000", background=True) +host = sandbox.get_host(3000) +url = f"https://{host}" +print('Server started at:', url) + +# Fetch data from the server inside the sandbox. +response = sandbox.commands.run(f"curl {url}") +data = response.stdout +print("Response from server inside sandbox:", data) + +# Kill the server process inside the sandbox. +process.kill() +``` + + + +This output will look like this: + +```bash JavaScript & TypeScript +Server started at: https://3000-ip3nfrvajtqu5ktoxugc7-b0b684e9.e2b.dev +Response from server inside sandbox: + + + +Directory listing for / + + +

    Directory listing for /

    +
    +     +
    + + +``` +```bash Python +Server started at: https://3000-ip3nfrvajtqu5ktoxugc7-b0b684e9.e2b.dev +Response from server inside sandbox: + + + +Directory listing for / + + +

    Directory listing for /

    +
    + +
    + + +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-api/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-api/index.mdx new file mode 100644 index 0000000000..d9166e7518 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-api/index.mdx @@ -0,0 +1,151 @@ +--- +title: "Monitor sandbox lifecycle Events" +sidebarTitle: Lifecycle events API +--- + +The lifecycle API provides RESTful endpoints to request the latest sandbox lifecycle events. This allows you to track when sandboxes are created, paused, resumed, updated, or killed, along with metadata. +All requests require authentication using your team [API key](/api-key#where-to-find-api-key). + +Query Parameters: +- `offset` (optional): Number of events to skip (default: 0, min: 0) +- `limit` (optional): Number of events to return (default: 10, min: 1, max: 100) +- `orderAsc` (optional): Sort order - true for ascending, false for descending (default: false) + + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() + +// Get the latest events for a specific sandbox +const resp1 = await fetch( + `https://api.e2b.app/events/sandboxes/${sbx.id}`, + { + method: 'GET', + headers: { + 'X-API-Key': E2B_API_KEY, + }, + } +) +const sandboxEvents = await resp1.json() + +// Get the latest 10 events for all sandboxes associated with the team +const resp2 = await fetch( + 'https://api.e2b.app/events/sandboxes?limit=10', + { + method: 'GET', + headers: { + 'X-API-Key': E2B_API_KEY, + }, + } +) +const teamSandboxEvents = await resp2.json() + +console.log(teamSandboxEvents) + +// [ +// { +// "eventCategory": "lifecycle", +// "eventData": null, +// "eventLabel": "kill", +// "sandboxBuildId": "a979a14b-bdcc-49e6-bc04-1189fc9fe7c2", +// "sandboxExecutionId": "1dae9e1c-9957-4ce7-a236-a99d5779aadf", +// "sandboxId": "${SANDBOX_ID}", +// "sandboxTeamId": "460355b3-4f64-48f9-9a16-4442817f79f5", +// "sandboxTemplateId": "rki5dems9wqfm4r03t7g", +// "timestamp": "2025-08-06T20:59:36Z" +// }, +// { +// "eventCategory": "lifecycle", +// "eventData": { +// "set_timeout": "2025-08-06T20:59:59Z" +// }, +// "eventLabel": "update", +// "sandboxBuildId": "a979a14b-bdcc-49e6-bc04-1189fc9fe7c2", +// "sandboxExecutionId": "1dae9e1c-9957-4ce7-a236-a99d5779aadf", +// "sandboxId": "${SANDBOX_ID}", +// "sandboxTeamId": "460355b3-4f64-48f9-9a16-4442817f79f5", +// "sandboxTemplateId": "rki5dems9wqfm4r03t7g", +// "timestamp": "2025-08-06T20:59:29Z" +// }, +// [...] +// { +// "eventCategory": "lifecycle", +// "eventData": null, +// "eventLabel": "create", +// "sandboxBuildId": "a979a14b-bdcc-49e6-bc04-1189fc9fe7c2", +// "sandboxExecutionId": "1dae9e1c-9957-4ce7-a236-a99d5779aadf", +// "sandboxId": "${SANDBOX_ID}", +// "sandboxTeamId": "460355b3-4f64-48f9-9a16-4442817f79f5", +// "sandboxTemplateId": "rki5dems9wqfm4r03t7g", +// "timestamp": "2025-08-06T20:59:24Z" +// } +// ] +``` +```python Python +import requests +from e2b_code_interpreter import Sandbox + +sbx = Sandbox() + +# Get the latest events for a specific sandbox +resp1 = requests.get( + f"https://api.e2b.app/events/sandboxes/{sbx.sandbox_id}", + headers={ + "X-API-Key": E2B_API_KEY, + } +) +sandbox_events = resp1.json() + +# Get the latest 10 events for all sandboxes associated with the team +resp2 = requests.get( + "https://api.e2b.app/events/sandboxes?limit=10", + headers={ + "X-API-Key": E2B_API_KEY, + } +) +team_sandbox_events = resp2.json() + +print(team_sandbox_events) + +# [ +# { +# "eventCategory": "lifecycle", +# "eventData": null, +# "eventLabel": "kill", +# "sandboxBuildId": "a979a14b-bdcc-49e6-bc04-1189fc9fe7c2", +# "sandboxExecutionId": "1dae9e1c-9957-4ce7-a236-a99d5779aadf", +# "sandboxId": "${SANDBOX_ID}", +# "sandboxTeamId": "460355b3-4f64-48f9-9a16-4442817f79f5", +# "sandboxTemplateId": "rki5dems9wqfm4r03t7g", +# "timestamp": "2025-08-06T20:59:36Z" +# }, +# { +# "eventCategory": "lifecycle", +# "eventData": { +# "set_timeout": "2025-08-06T20:59:59Z" +# }, +# "eventLabel": "update", +# "sandboxBuildId": "a979a14b-bdcc-49e6-bc04-1189fc9fe7c2", +# "sandboxExecutionId": "1dae9e1c-9957-4ce7-a236-a99d5779aadf", +# "sandboxId": "${SANDBOX_ID}", +# "sandboxTeamId": "460355b3-4f64-48f9-9a16-4442817f79f5", +# "sandboxTemplateId": "rki5dems9wqfm4r03t7g", +# "timestamp": "2025-08-06T20:59:29Z" +# }, +# [...] +# { +# "eventCategory": "lifecycle", +# "eventData": null, +# "eventLabel": "create", +# "sandboxBuildId": "a979a14b-bdcc-49e6-bc04-1189fc9fe7c2", +# "sandboxExecutionId": "1dae9e1c-9957-4ce7-a236-a99d5779aadf", +# "sandboxId": "${SANDBOX_ID}", +# "sandboxTeamId": "460355b3-4f64-48f9-9a16-4442817f79f5", +# "sandboxTemplateId": "rki5dems9wqfm4r03t7g", +# "timestamp": "2025-08-06T20:59:24Z" +# } +# ] +``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-webhooks/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-webhooks/index.mdx new file mode 100644 index 0000000000..bf6aa23c9d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/lifecycle-events-webhooks/index.mdx @@ -0,0 +1,270 @@ +--- +title: "Sandbox lifecycle webhooks" +sidebarTitle: Lifecycle events webhooks +--- + +Webhooks provide a way for notifications to be delivered to an external web server whenever certain sandbox lifecycle events occur. +This allows you to receive real-time updates about sandbox creation, updates, and termination without having to poll the API. +All webhook requests require authentication using your team [API key](/api-key#where-to-find-api-key). + +## Webhook management + +### Register webhook + +Register a new webhook to receive sandbox lifecycle events. +The webhook will be registered for the team ID associated with your API key. You will receive webhook notifications for sandbox lifecycle events from sandboxes created by your team with the [following payload](#webhook-payload). + + + +```js JavaScript & TypeScript +// Register a new webhook +const resp = await fetch( + 'https://api.e2b.app/events/webhooks/sandboxes', + { + method: 'POST', + headers: { + 'X-API-Key': E2B_API_KEY, + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ + url: 'https://your-webhook-endpoint.com/webhook', + events: ['create', 'kill', 'update'] + }), + } +) + +if (resp.status === 201) { + console.log('Webhook registered successfully') +} +``` +```python Python +import requests + +# Register a new webhook +resp = requests.post( + "https://api.e2b.app/events/webhooks/sandboxes", + headers={ + "X-API-Key": E2B_API_KEY, + "Content-Type": "application/json", + }, + json={ + "url": "https://your-webhook-endpoint.com/webhook", + "events": ["create", "kill", "update"] + } +) + +if resp.status_code == 201: + print("Webhook registered successfully") +``` + + + +### Get webhook configuration + +Retrieve the current webhook configuration for your team. + + +```js JavaScript & TypeScript +// Get current webhook configuration +const resp = await fetch( + 'https://api.e2b.app/events/webhooks/sandboxes', + { + method: 'GET', + headers: { + 'X-API-Key': E2B_API_KEY, + }, + } +) +const webhookConfig = await resp.json() +console.log(webhookConfig) +// { +// "teamID": "", +// "url": "https://your-webhook-endpoint.com/webhook", +// "events": ["create", "kill"] +// } + +``` +```python Python +import requests + +# Get current webhook configuration +resp = requests.get( + "https://api.e2b.app/events/webhooks/sandboxes", + headers={ + "X-API-Key": E2B_API_KEY, + } +) + +webhook_config = resp.json() +print(webhook_config) +# { +# "teamID": "", +# "events": ["create", "kill"] +# "url": "https://your-webhook-endpoint.com/webhook", +# } +``` + + +### Update webhook configuration + +Update an existing webhook configuration. The update will replace the previous configuration fields with provided fields. + + +```js JavaScript & TypeScript +// Update webhook configuration +const resp = await fetch( + 'https://api.e2b.app/events/webhooks/sandboxes', + { + method: 'PATCH', + headers: { + 'X-API-Key': E2B_API_KEY, + 'Content-Type': 'application/json', + }, + body: JSON.stringify({ + url: 'https://your-updated-webhook-endpoint.com/webhook', + events: ['create'] + }), + } +) + +const updatedWebhookConfig = await resp.json() +console.log(updatedWebhookConfig) +// { +// "teamID": "", +// "events": ["create"], +// "url": "https://your-updated-webhook-endpoint.com/webhook" +// } +``` +```python Python +import requests + +# Update webhook configuration +resp = requests.patch( + "https://api.e2b.app/events/webhooks/sandboxes", + headers={ + "X-API-Key": E2B_API_KEY, + "Content-Type": "application/json", + }, + json={ + "url": "https://your-updated-webhook-endpoint.com/webhook", + "events": ["create"] + } +) + +updated_webhook_config = resp.json() +print(updated_webhook_config) +# { +# "teamID": "", +# "events": ["create"], +# "url": "https://your-updated-webhook-endpoint.com/webhook" +# } +``` + + +### Delete webhook + +Unregister the webhook. + + +```js JavaScript & TypeScript +// Delete webhook configuration +const resp = await fetch( + 'https://api.e2b.app/events/webhooks/sandboxes', + { + method: 'DELETE', + headers: { + 'X-API-Key': E2B_API_KEY, + }, + } +) + +if (resp.status === 200) { + console.log('Webhook deleted successfully') +} +``` +```python Python +import requests + +# Delete webhook configuration +resp = requests.delete( + "https://api.e2b.app/events/webhooks/sandboxes", + headers={ + "X-API-Key": E2B_API_KEY, + } +) + +if resp.status_code == 200: + print("Webhook deleted successfully") +``` + + +### Test webhook + +Send a test webhook to verify your endpoint is working correctly. + + +```js JavaScript & TypeScript +// Test webhook endpoint +const resp = await fetch( + 'https://api.e2b.app/events/webhooks/sandboxes/test', + { + method: 'POST', + headers: { + 'X-API-Key': E2B_API_KEY, + }, + } +) + +if (resp.status === 200) { + console.log('Test webhook sent successfully') +} +``` +```python Python +import requests + +# Test webhook endpoint +resp = requests.post( + "https://api.e2b.app/events/webhooks/sandboxes/test", + headers={ + "X-API-Key": E2B_API_KEY, + } +) + +if resp.status_code == 200: + print("Test webhook sent successfully") +``` + + +## Webhook payload + +When a webhook is triggered, your endpoint will receive a POST request with a JSON payload containing the sandbox event data. The payload structure matches the event format from the API: + +```json +{ + "eventCategory": "lifecycle", + "eventData": { + "sandbox_metadata": { + "": "" + } + }, + "eventLabel": "create", + "sandboxBuildId": "a979a14b-bdcc-49e6-bc04-1189fc9fe7c2", + "sandboxExecutionId": "1dae9a1c-9957-4ce7-a236-a99d5779aadf", + "sandboxId": "", + "sandboxTeamId": "", + "sandboxTemplateId": "rki5dems9wqfm4r03t7g", + "timestamp": "2025-08-06T20:59:24Z" +} +``` + +## Available event types + +The following event types can be subscribed to via webhooks, they are used as the `eventLabel` field in the [payload](#webhook-payload). + +- `create` - Sandbox creation +- `kill` - Sandbox termination +- `update` - Sandbox configuration updates +- `pause` - Sandbox pausing +- `resume` - Sandbox resuming + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx new file mode 100644 index 0000000000..80092d771b --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx @@ -0,0 +1,339 @@ +--- +title: "List sandboxes" +--- + +You can list sandboxes using the `Sandbox.list()` method. + + + Once you have information about running sandbox, you can [connect](/sandbox/connect) to it using the `Sandbox.connect()` method. + + +### Listing sandboxes + +The `Sandbox.list()` method supports pagination. In the [advanced pagination](/sandbox/list#advanced-pagination) section, you can find more information about pagination techniques using the updated method. + + + ```js JavaScript & TypeScript highlight={6,11,14,24} + import { Sandbox, SandboxInfo } from '@e2b/code-interpreter' + + const sandbox = await Sandbox.create( + { + metadata: { + name: 'My Sandbox', // $HighlightLine + }, + }, + ) + + const paginator = Sandbox.list() // $HighlightLine + + // Get the first page of sandboxes (running and paused) + const firstPage = await paginator.nextItems() // $HighlightLine + + const runningSandbox = firstPage[0] + + console.log('Running sandbox metadata:', runningSandbox.metadata) + console.log('Running sandbox id:', runningSandbox.sandboxId) + console.log('Running sandbox started at:', runningSandbox.startedAt) + console.log('Running sandbox template id:', runningSandbox.templateId) + + // Get the next page of sandboxes + const nextPage = await paginator.nextItems() // $HighlightLine + ``` + ```python Python highlight={5,9,12,22} + from e2b_code_interpreter import Sandbox, SandboxInfo + + sandbox = Sandbox.create( + metadata={ + "name": "My Sandbox", # $HighlightLine + }, + ) + + paginator = Sandbox.list() # $HighlightLine + + # Get the first page of sandboxes (running and paused) + firstPage = paginator.next_items() # $HighlightLine + + running_sandbox = firstPage[0] + + print('Running sandbox metadata:', running_sandbox.metadata) + print('Running sandbox id:', running_sandbox.sandbox_id) + print('Running sandbox started at:', running_sandbox.started_at) + print('Running sandbox template id:', running_sandbox.template_id) + + # Get the next page of sandboxes + nextPage = paginator.next_items() # $HighlightLine + ``` + +The code above will output something like this: + + ```bash JavaScript & TypeScript + Running sandbox metadata: {name: "My Sandbox"} + Running sandbox id: ixjj3iankaishgcge4jwn-b0b684e9 + Running sandbox started at: 2024-10-15T21:13:07.311Z + Running sandbox template id: 3e4rngfa34txe0gxc1zf + ``` + ```bash Python + Running sandbox metadata: {'name': 'My Sandbox'} + Running sandbox id: ixjj3iankaishgcge4jwn-b0b684e9 + Running sandbox started at: 2024-10-15 21:13:07.311861+00:00 + Running sandbox template id: 3e4rngfa34txe0gxc1zf + ``` + + + +### Filtering sandboxes + +Filter sandboxes by their current state. The state parameter can contain either "**running**" for running sandboxes or "**paused**" for paused sandboxes, or both. + + + ```js JavaScript & TypeScript highlight={9,13} + import { Sandbox } from '@e2b/code-interpreter' + + // Create a sandbox. + const sandbox = await Sandbox.create() + + // List sandboxes that are running or paused. + const paginator = Sandbox.list({ + query: { + state: ['running', 'paused'], // $HighlightLine + }, + }) + + const sandboxes = await paginator.nextItems() // $HighlightLine + ``` + ```python Python highlight={9,14} + from e2b_code_interpreter import Sandbox, SandboxQuery, SandboxState + + # Create a sandbox with metadata. + sandbox = Sandbox.create() + + # List sandboxes that are running or paused. + paginator = Sandbox.list( + query=SandboxQuery( + state=[SandboxState.RUNNING, SandboxState.PAUSED], # $HighlightLine + ), + ) + + # Get the first page of sandboxes (running and paused) + sandboxes = paginator.next_items() # $HighlightLine + ``` + + +Filter sandboxes by the metadata key value pairs specified during Sandbox creation. + + + ```js JavaScript & TypeScript highlight={6-8,15,18} + import { Sandbox } from '@e2b/code-interpreter' + + // Create sandbox with metadata. + const sandbox = await Sandbox.create({ + metadata: { + env: 'dev', // $HighlightLine + app: 'my-app', // $HighlightLine + userId: '123', // $HighlightLine + }, + }) + + // List all sandboxes that has `userId` key with value `123` and `env` key with value `dev`. + const paginator = Sandbox.list({ + query: { + metadata: { userId: '123', env: 'dev' }, // $HighlightLine + }, + }) + + const sandboxes = await paginator.nextItems() // $HighlightLine + ``` + ```python Python highlight={6-8,16-17} + from e2b_code_interpreter import Sandbox, SandboxQuery, SandboxState + + # Create sandbox with metadata. + sandbox = Sandbox.create( + metadata={ + "env": "dev", # $HighlightLine + "app": "my-app", # $HighlightLine + "user_id": "123", # $HighlightLine + }, + ) + + # List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`. + paginator = Sandbox.list( + query=SandboxQuery( + metadata={ + "userId": "123", # $HighlightLine + "env": "dev", # $HighlightLine + } + ), + ) + + # Get the first page of sandboxes (running and paused) + sandboxes = paginator.next_items() + ``` + + +### Advanced pagination + +For more granular pagination, you can set custom per-page item limit (default and maximum is **100**) and specify an offset parameter (`nextToken` or `next_token`) to start paginating from. + + + ```js JavaScript & TypeScript highlight={4-5,16} + import { Sandbox } from '@e2b/code-interpreter' + + const paginator = Sandbox.list({ + limit: 100, // $HighlightLine + nextToken: '', // $HighlightLine + }) + + // Additional paginator properties + // Whether there is a next page + paginator.hasNext + + // Next page token + paginator.nextToken + + // Fetch the next page + await paginator.nextItems() // $HighlightLine + ``` + ```python Python highlight={5-6,13} + from e2b_code_interpreter import Sandbox + + # List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`. + paginator = Sandbox.list( + limit=100, # $HighlightLine + next_token="", # $HighlightLine + ) + + paginator.has_next # Whether there is a next page + paginator.next_token # Next page token + + # Fetch the next page + paginator.next_items() # $HighlightLine + ``` + + +You can fetch all pages by looping through the paginator while checking if there is a next page (using `hasNext` or `has_next` property) and fetching until there are no more pages left to fetch: + + + ```js JavaScript & TypeScript highlight={7} + import { Sandbox } from '@e2b/code-interpreter' + + const paginator = Sandbox.list() + + // Loop through all pages + const sandboxes: SandboxInfo[] = [] + while (paginator.hasNext) { // $HighlightLine + const items = await paginator.nextItems() + sandboxes.push(...items) + } + ``` + ```python Python highlight={7} + from e2b_code_interpreter import Sandbox, SandboxQuery + + paginator = Sandbox.list() + + # Loop through all pages + sandboxes: list[SandboxInfo] = [] + while paginator.has_next: # $HighlightLine + items = paginator.next_items() + sandboxes.extend(items) + ``` + + +## Old SDK (v1.x.y) + + + If you're using SDK with version lower than `2.0.0`, the `Sandbox.list()` method behaves differently. + + + + + ```js JavaScript & TypeScript highlight={11} + import { Sandbox } from '@e2b/code-interpreter' + + // Create a sandbox. + const sandbox = await Sandbox.create({ + metadata: { + name: 'My Sandbox', + }, + }) + + // List all running sandboxes. + const runningSandboxes = await Sandbox.list() // $HighlightLine + const runningSandbox = runningSandboxes[0] + + console.log('Running sandbox metadata:', runningSandbox.metadata) + console.log('Running sandbox id:', runningSandbox.sandboxId) + console.log('Running sandbox started at:', runningSandbox.startedAt) + console.log('Running sandbox template id:', runningSandbox.templateId) + ``` + ```python Python highlight={11} + from e2b_code_interpreter import Sandbox + + # Create a sandbox. + sandbox = Sandbox.create( + metadata: { + name: 'My Sandbox', + }, + ) + + # List all running sandboxes. + running_sandboxes = Sandbox.list() # $HighlightLine + running_sandbox = running_sandboxes[0] + + print('Running sandbox metadata:', running_sandbox.metadata) + print('Running sandbox id:', running_sandbox.sandbox_id) + print('Running sandbox started at:', running_sandbox.started_at) + print('Running sandbox template id:', running_sandbox.template_id) + ``` + + +## Filtering sandboxes + +You can filter sandboxes by specifying [Metadata](/sandbox/metadata) key value pairs. +Specifying multiple key value pairs will return sandboxes that match all of them. + +This can be useful when you have a large number of sandboxes and want to find only specific ones. The filtering is performed on the server. + + + ```js JavaScript & TypeScript highlight={6-8,15} + import { Sandbox } from '@e2b/code-interpreter' + + // Create sandbox with metadata. + const sandbox = await Sandbox.create({ + metadata: { + env: 'dev', // $HighlightLine + app: 'my-app', // $HighlightLine + userId: '123', // $HighlightLine + }, + }) + + // List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`. + const runningSandboxes = await Sandbox.list({ + query: { + metadata: { userId: '123', env: 'dev' }, // $HighlightLine + }, + }) + ``` + ```python Python highlight={7-9,17-18} + from e2b_code_interpreter import Sandbox + from e2b.sandbox.sandbox_api import SandboxQuery + + # Create sandbox with metadata. + sandbox = Sandbox.create( + metadata={ + "env": "dev", # $HighlightLine + "app": "my-app", # $HighlightLine + "user_id": "123", # $HighlightLine + }, + ) + + # List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`. + running_sandboxes = Sandbox.list( + query=SandboxQuery( + metadata={ + "userId": "123", # $HighlightLine + "env": "dev", # $HighlightLine + } + ), + ) + ``` + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx new file mode 100644 index 0000000000..26e2ce5f0a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx @@ -0,0 +1,59 @@ +--- +title: "Sandbox metadata" +sidebarTitle: Metadata +--- + +Metadata is a way to attach arbitrary key-value pairs for a sandbox. + +This is useful in various scenarios, for example: +- Associate a sandbox with a user session. +- Store custom user data for a sandbox like API keys. +- Associate a sandbox with a user ID and [connect to it later](/sandbox/connect). + +You specify metadata when creating a sandbox and can access it later through listing running sandboxes with `Sandbox.list()` method. + + +If you're using the [beta version of the SDK](/sandbox/installing-beta-sdks), the `Sandbox.list()` method was updated. See [List Sandboxes](/sandbox/list#changes-in-the-beta-sdks) for more information. + + + +```js JavaScript & TypeScript highlight={6} +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with metadata. +const sandbox = await Sandbox.create({ + metadata: { + userId: '123', // $HighlightLine + }, +}) + +// List running sandboxes and access metadata. +const runningSandboxes = await Sandbox.list() +// Will print: +// { +// 'userId': '123', +// } +console.log(runningSandboxes[0].metadata) +``` +```python Python highlight={6} +from e2b_code_interpreter import Sandbox + +# Create sandbox with metadata. +sandbox = Sandbox.create( + metadata={ + 'userId': '123', # $HighlightLine + }, +) + +# List running sandboxes and access metadata. +running_sandboxes = Sandbox.list() +# Will print: +# { +# 'userId': '123', +# } +print(running_sandboxes[0].metadata) +``` + + +## Filtering sandboxes by metadata +You can also filter sandboxes by metadata, you can find more about it [here](/sandbox/list#filtering-sandboxes). \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx new file mode 100644 index 0000000000..99d6545685 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx @@ -0,0 +1,110 @@ +--- +title: "Sandbox metrics" +sidebarTitle: Metrics +--- + +The sandbox metrics allows you to get information about the sandbox's CPU, memory and disk usage. + +## Getting sandbox metrics +Getting the metrics of a sandbox returns an array of timestamped metrics containing CPU, memory and disk usage information. +The metrics are collected every 5 seconds. + +### Getting sandbox metrics using the SDKs + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +console.log('Sandbox created', sbx.sandboxId) + +// Wait for a few seconds to collect some metrics +await new Promise((resolve) => setTimeout(resolve, 10_000)) + +const metrics = await sbx.getMetrics() // $HighlightLine + +// You can also get the metrics by sandbox ID: +// const metrics = await Sandbox.getMetrics(sbx.sandboxId) + +console.log('Sandbox metrics:', metrics) + +// Sandbox metrics: +// [ +// { +// timestamp: 2025-07-28T08:04:05.000Z, +// cpuUsedPct: 20.33, +// cpuCount: 2, +// memUsed: 32681984, // in bytes +// memTotal: 507592704, // in bytes +// diskUsed: 1514856448, // in bytes +// diskTotal: 2573185024 // in bytes +// }, +// { +// timestamp: 2025-07-28T08:04:10.000Z, +// cpuUsedPct: 0.2, +// cpuCount: 2, +// memUsed: 33316864, // in bytes +// memTotal: 507592704, // in bytes +// diskUsed: 1514856448, // in bytes +// diskTotal: 2573185024 // in bytes +// } +// ] +``` +```python Python +from time import sleep +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +print('Sandbox created', sbx.sandbox_id) + +# Wait for a few seconds to collect some metrics +sleep(10) + +metrics = sbx.get_metrics() # $HighlightLine + +# You can also get the metrics by sandbox ID: +# metrics = Sandbox.get_metrics(sbx.sandbox_id) + +print('Sandbox metrics', metrics) + +# Sandbox metrics +# [ +# SandboxMetric( +# cpu_count=2, +# cpu_used_pct=13.97, +# disk_total=2573185024, # in bytes +# disk_used=1514856448, # in bytes +# mem_total=507592704, # in bytes +# mem_used=30588928, # in bytes +# timestamp=datetime.datetime(2025, 7, 28, 8, 8, 15, tzinfo=tzutc()), +# ), +# SandboxMetric( +# cpu_count=2, +# cpu_used_pct=0.1, +# disk_total=2573185024, # in bytes +# disk_used=1514856448, # in bytes +# mem_total=507592704, # in bytes +# mem_used=31084544, # in bytes +# timestamp=datetime.datetime(2025, 7, 28, 8, 8, 20, tzinfo=tzutc()), +# ), +# ] +``` + + +### Getting sandbox metrics using the CLI + +```bash Terminal +e2b sandbox metrics # $HighlightLine + +# Metrics for sandbox +# +# [2025-07-25 14:05:55Z] CPU: 8.27% / 2 Cores | Memory: 31 / 484 MiB | Disk: 1445 / 2453 MiB +# [2025-07-25 14:06:00Z] CPU: 0.5% / 2 Cores | Memory: 32 / 484 MiB | Disk: 1445 / 2453 MiB +# [2025-07-25 14:06:05Z] CPU: 0.1% / 2 Cores | Memory: 32 / 484 MiB | Disk: 1445 / 2453 MiB +# [2025-07-25 14:06:10Z] CPU: 0.3% / 2 Cores | Memory: 32 / 484 MiB | Disk: 1445 / 2453 MiB +``` + + + + It may take a second or more to get the first metrics after the sandbox is created. Until the first metrics are collected from the sandbox, you will get an empty array. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx new file mode 100644 index 0000000000..4cae732d2d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx @@ -0,0 +1,277 @@ +--- +title: "Sandbox persistence" +sidebarTitle: Persistence +--- + + +Sandbox persistence is currently in public beta: +1. Consider [some limitations](#limitations-while-in-beta). +2. The persistence is free for all users during the beta. + + +The sandbox persistence allows you to pause your sandbox and resume it later from the same state it was in when you paused it. + +This includes not only state of the sandbox's filesystem but also the sandbox's memory. This means all running processes, loaded variables, data, etc. + +## Sandbox State Transitions + +Understanding how sandboxes transition between different states is crucial for managing their lifecycle effectively. Here's a diagram showing the possible state transitions: + + + + + +### State descriptions + +- **Running**: The sandbox is actively running and can execute code. This is the initial state after creation. +- **Paused**: The sandbox execution is suspended but its state is preserved. +- **Killed**: The sandbox is terminated and all resources are released. This is a terminal state. + +### Changing sandbox's state + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() // Starts in Running state + +// Pause the sandbox +await sandbox.betaPause() // Running → Paused + +// Resume the sandbox +await sandbox.connect() // Running/Paused → Running + +// Kill the sandbox (from any state) +await sandbox.kill() // Running/Paused → Killed +``` + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() # Starts in Running state + +# Pause the sandbox +sandbox.betaPause() # Running → Paused + +# Resume the sandbox +sandbox.connect() # Running/Paused → Running + +# Kill the sandbox (from any state) +sandbox.kill() # Running/Paused → Killed +``` + + +## Pausing sandbox +When you pause a sandbox, both the sandbox's filesystem and memory state will be saved. This includes all the files in the sandbox's filesystem and all the running processes, loaded variables, data, etc. + + +```js JavaScript & TypeScript highlight={8-9} +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +console.log('Sandbox created', sbx.sandboxId) + +// Pause the sandbox +// You can save the sandbox ID in your database to resume the sandbox later +await sbx.betaPause() // $HighlightLine +console.log('Sandbox paused', sbx.sandboxId) // $HighlightLine +``` +```python Python highlight={8-9} +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +print('Sandbox created', sbx.sandbox_id) + +# Pause the sandbox +# You can save the sandbox ID in your database to resume the sandbox later +sbx.beta_pause() # $HighlightLine +print('Sandbox paused', sbx.sandbox_id) # $HighlightLine +``` + + + +## Resuming sandbox +When you resume a sandbox, it will be in the same state it was in when you paused it. +This means that all the files in the sandbox's filesystem will be restored and all the running processes, loaded variables, data, etc. will be restored. + + +```js JavaScript & TypeScript highlight={12-13} +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +console.log('Sandbox created', sbx.sandboxId) + +// Pause the sandbox +// You can save the sandbox ID in your database to resume the sandbox later +await sbx.betaPause() +console.log('Sandbox paused', sbx.sandboxId) + +// Connect to the sandbox (it will automatically resume the sandbox, if paused) +const sameSbx = await sbx.connect() // $HighlightLine +console.log('Connected to the sandbox', sameSbx.sandboxId) // $HighlightLine +``` +```python Python highlight={12-13} +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() +print('Sandbox created', sbx.sandbox_id) + +# Pause the sandbox +# You can save the sandbox ID in your database to resume the sandbox later +sbx.beta_pause() +print('Sandbox paused', sandbox_id) + +# Connect to the sandbox (it will automatically resume the sandbox, if paused) +same_sbx = sbx.connect() # $HighlightLine +print('Connected to the sandbox', same_sbx.sandbox_id) # $HighlightLine +``` + + +## Listing paused sandboxes +You can list all paused sandboxes by calling the `Sandbox.list` method and supplying the `state` query parameter. +More information about using the method can be found in [List Sandboxes](/sandbox/list). + + +```js JavaScript & TypeScript highlight={4,7} +import { Sandbox, SandboxInfo } from '@e2b/code-interpreter' + +// List all paused sandboxes +const paginator = Sandbox.list({ query: { state: ['paused'] } }) // $HighlightLine + +// Get the first page of paused sandboxes +const sandboxes = await paginator.nextItems() // $HighlightLine + +// Get all paused sandboxes +while (paginator.hasNext) { + const items = await paginator.nextItems() + sandboxes.push(...items) +} +``` +```python Python highlight={4,7} +# List all paused sandboxes +from e2b_code_interpreter import Sandbox, SandboxQuery, SandboxState + +paginator = Sandbox.list(SandboxQuery(state=[SandboxState.PAUSED])) # $HighlightLine + +# Get the first page of paused sandboxes +sandboxes = paginator.next_items() # $HighlightLine + +# Get all paused sandboxes +while paginator.has_next: + items = paginator.next_items() + sandboxes.extend(items) +``` + + +## Removing paused sandboxes + +You can remove paused sandboxes by calling the `kill` method on the Sandbox instance. + + +```js JavaScript & TypeScript highlight={11,14} +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.create() +console.log('Sandbox created', sbx.sandboxId) + +// Pause the sandbox +// You can save the sandbox ID in your database to resume the sandbox later +await sbx.betaPause() + +// Remove the sandbox +await sbx.kill() // $HighlightLine + +// Remove sandbox by id +await Sandbox.kill(sbx.sandboxId) // $HighlightLine +``` +```python Python highlight={9,12} +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.create() + +# Pause the sandbox +sbx.beta_pause() + +# Remove the sandbox +sbx.kill() # $HighlightLine + +# Remove sandbox by id +Sandbox.kill(sbx.sandbox_id) # $HighlightLine +``` + + +## Sandbox's timeout +When you connect to a sandbox, the sandbox's timeout is reset to the default timeout of an E2B sandbox - 5 minutes. + +You can pass a custom timeout to the `Sandbox.connect()`/`Sandbox.connect()` method like this: + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +const sbx = await Sandbox.connect(sandboxId, { timeoutMs: 60 * 1000 }) // 60 seconds +``` +```python Python +from e2b_code_interpreter import Sandbox + +sbx = Sandbox.connect(sandbox_id, timeout=60) # 60 seconds +``` + + + +### Auto-pause (beta) + +**Note: Auto-pause is currently in beta and available through `Sandbox.betaCreate()`/`Sandbox.beta_create()` method.** + +Sandboxes can now automatically pause after they time out. When a sandbox is paused, it stops consuming compute but preserves its state. The default inactivity timeout is 10 minutes. You can change the timeout by passing the `timeoutMs`/`timeout` parameter to the `Sandbox.connect()`/`Sandbox.connect()` method. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with auto-pause enabled +const sandbox = await Sandbox.betaCreate({ + autoPause: true, + timeoutMs: 10 * 60 * 1000 // Optional: change the default timeout (10 minutes) +}) +```python Python +from e2b_code_interpreter import Sandbox +# Create sandbox with auto-pause enabled (Beta) +sandbox = Sandbox.beta_create( + auto_pause=True # Auto-pause after the sandbox times out + timeout=10 * 60, # Optional: change the default timeout (10 minutes) +) + + +The auto-pause is persistent, meaning that if your sandbox resumes and it times out, it will be automatically paused again. + +If you `.kill()` the sandbox, it will be permanently deleted and you won't be able to resume it. + + +```js JavaScript & TypeScript +import { Sandbox } from '@e2b/code-interpreter' + +// Create sandbox with auto-pause enabled (Beta) +const sandbox = await Sandbox.betaCreate({ + autoPause: true // Auto-pause after the sandbox times out +}) +``` +```python Python +from e2b_code_interpreter import Sandbox +# Create sandbox with auto-pause enabled (Beta) +sandbox = Sandbox.beta_create( + auto_pause=True # Auto-pause after the sandbox times out +) +``` + + +## Network +If you have a service (for example a server) running inside your sandbox and you pause the sandbox, the service won't be accessible from the outside and all the clients will be disconnected. +If you resume the sandbox, the service will be accessible again but you need to connect clients again. + + +## Limitations while in beta +- Pausing a sandbox takes about 4 seconds per 1 GiB of RAM +- Resuming a sandbox takes about 1 second +- Sandbox can be used up to 30 days + - After 30 days from the initial sandbox create call, the data may be deleted and you will not be able to resume it. Attempting to resume a sandbox that was deleted or does not exist will result in the `NotFoundError` in the JavaScript SDK or the `NotFoundException` in the Python SDK \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/rate-limits/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/rate-limits/index.mdx new file mode 100644 index 0000000000..2f975eb177 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/rate-limits/index.mdx @@ -0,0 +1,128 @@ +--- +title: "Rate Limits" +sidebarTitle: "Rate limits" +--- + +This page describes API and sandbox rate limits of the E2B platform. + +## Table of Contents + +- [Sandbox lifecycle & management API](##sandbox-lifecycle-%26-management-api) +- [Sandbox operations & requests to sandboxes](#sandbox-operations-%26-requests-to-sandboxes) +- [Concurrent Sandboxes](#concurrent-sandboxes) +- [Sandbox creation rate](#sandbox-creation-rate) +- [Reaching limits](#reaching-limits) +- [Increasing and avoiding rate limits](#increasing-and-avoiding-rate-limits) + +Here's a limits breakdown table based on the plan: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PlanHobbyProEnterprise
    Sandbox lifecycle & management API20,000 / 30s20,000 / 30sCustom
    Sandbox operations40,000 / 60s per IP40,000 / 60s per IPCustom
    Concurrent sandboxes20100 - 1,100*Custom
    Sandbox creation rate1 / sec5 / secCustom
    + + + * Pro plan default is 100 concurrent sandboxes. Higher concurrency up to 1,100 is available as a separate addon that can be purchased. + + +--- + +## Sandbox lifecycle & management API + +**20,000 requests per 30 seconds** + +This rate limit applies to lifecycle and management operations such as sandbox create, kill, update, list, and other. + +--- + +## Sandbox operations & requests to sandboxes + +**40,000 requests per 60 seconds** + +This rate limits applies to operations to/within running sandboxes such as running code, listing files, running commands, etc. +This also includes requests made to custom ports in the sandbox. + +
    This limit is enforced globally across all sandbox operations from a single IP address. + +--- + +## Concurrent sandboxes + +Number of concurrent sandboxes differs based on the pricing tier. + +### Hobby tier +**Up to 20 concurrent sandboxes** + +### Pro tier +**Starts at 100 concurrent sandboxes** + + +Can go up to 1,100 with a separate addon available for purchase. + + + +### Enterprise tier +**Custom limit - 1,100+ concurrent sandboxes** + +--- + +## Sandbox creation rate + +This limit controls how quickly you can create new sandboxes. + +### Hobby tier +**1 sandbox per second** + + +### Pro tier +**5 sandboxes per second** + +### Enterprise tier +**Custom limit - 5+ sandboxes per second** + +## Reaching limits + +When you reach the limits of your plan, subsequent requests/function calls will be effectively dropped and return the following: +- the `429 Too Many Requests` HTTP status code (when calling API/sandbox ports directly) +- `RateLimitError` in the JS/TS SDK +- `RateLimitException` in the Python SDK + +For example, if you're on the Pro tier (without any concurrency addons) you can create up to 100 sandboxes running concurrently. +If the 100 sandboxes are still running, requests for creating new sandboxes from the SDKs (`Sandbox.create()` in JS/TS or `Sandbox.create()` in Python) will fail and return `RateLimitError` or `RateLimitException` respectively. +After the number of running sandboxes drops below 100 or you purchase the concurrency addon, you'll be able to create new sandboxes again. + +## Increasing and avoiding rate limits + +You can avoid rate limits by either increasing your plan or contacting our sales team to discuss your specific requirements and we can provide tailored limits to meet your needs at [enterprise@e2b.dev](mailto:enterprise@e2b.dev). diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/template/index.mdx new file mode 100644 index 0000000000..1a03bda563 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.0/template/index.mdx @@ -0,0 +1,94 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/template/index.mdx new file mode 100644 index 0000000000..1a03bda563 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.1/template/index.mdx @@ -0,0 +1,94 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.10/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/template/index.mdx new file mode 100644 index 0000000000..1a03bda563 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.2/template/index.mdx @@ -0,0 +1,94 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/template/index.mdx new file mode 100644 index 0000000000..1a03bda563 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.3/template/index.mdx @@ -0,0 +1,94 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/template/index.mdx new file mode 100644 index 0000000000..1a03bda563 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.4/template/index.mdx @@ -0,0 +1,94 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/template/index.mdx new file mode 100644 index 0000000000..1a03bda563 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.5/template/index.mdx @@ -0,0 +1,94 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/template/index.mdx new file mode 100644 index 0000000000..1a03bda563 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.6/template/index.mdx @@ -0,0 +1,94 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.7/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.8/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.0.9/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.0/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.1/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.2/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.2.3/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.0/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.1/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.2/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.3/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.3.4/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/template/index.mdx new file mode 100644 index 0000000000..b121c54831 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.0/template/index.mdx @@ -0,0 +1,136 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/template/index.mdx new file mode 100644 index 0000000000..e0965e3323 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.1/template/index.mdx @@ -0,0 +1,137 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/template/index.mdx new file mode 100644 index 0000000000..e0965e3323 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.2/template/index.mdx @@ -0,0 +1,137 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/template/index.mdx new file mode 100644 index 0000000000..e0965e3323 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.4.3/template/index.mdx @@ -0,0 +1,137 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.0/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.1/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.5.2/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.6.0/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.7.0/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/sandbox/index.mdx new file mode 100644 index 0000000000..ec8e950a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/sandbox/index.mdx @@ -0,0 +1,93 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.8.0/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/sandbox/index.mdx new file mode 100644 index 0000000000..a30f5ce054 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/sandbox/index.mdx @@ -0,0 +1,111 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.0/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/sandbox/index.mdx new file mode 100644 index 0000000000..a30f5ce054 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/sandbox/index.mdx @@ -0,0 +1,111 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.1/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/sandbox/index.mdx new file mode 100644 index 0000000000..a30f5ce054 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/sandbox/index.mdx @@ -0,0 +1,111 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all running sandboxes + +##### Usage + +```bash +e2b sandbox list [options] +``` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox spawn + + +spawn sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v1.9.2/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..08c2d5a844 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/sandbox/index.mdx @@ -0,0 +1,118 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all sandboxes, by default it list only running ones + +##### Usage + +```bash +e2b sandbox list [options] +``` + +##### Options + + + - `-s, --state : filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : filter by metadata, eg. key1=value1 ` + - `-l, --limit : limit the number of sandboxes returned ` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox create + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox create [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.0/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..08c2d5a844 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/sandbox/index.mdx @@ -0,0 +1,118 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all sandboxes, by default it list only running ones + +##### Usage + +```bash +e2b sandbox list [options] +``` + +##### Options + + + - `-s, --state : filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : filter by metadata, eg. key1=value1 ` + - `-l, --limit : limit the number of sandboxes returned ` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox create + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox create [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.1/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/sandbox/index.mdx new file mode 100644 index 0000000000..9c83f6ac37 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/sandbox/index.mdx @@ -0,0 +1,136 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all sandboxes, by default it list only running ones + +##### Usage + +```bash +e2b sandbox list [options] +``` + +##### Options + + + - `-s, --state : filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : filter by metadata, eg. key1=value1 ` + - `-l, --limit : limit the number of sandboxes returned ` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox create + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox create [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox spawn + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.2/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/sandbox/index.mdx new file mode 100644 index 0000000000..9c83f6ac37 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/sandbox/index.mdx @@ -0,0 +1,136 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all sandboxes, by default it list only running ones + +##### Usage + +```bash +e2b sandbox list [options] +``` + +##### Options + + + - `-s, --state : filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : filter by metadata, eg. key1=value1 ` + - `-l, --limit : limit the number of sandboxes returned ` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxID] +``` + +##### Options + + + - `-a, --all: kill all running sandboxes ` + + +## e2b sandbox create + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox create [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox spawn + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/template/index.mdx new file mode 100644 index 0000000000..c70cf83fdc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.0.3/template/index.mdx @@ -0,0 +1,138 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/sandbox/index.mdx new file mode 100644 index 0000000000..a23bf130ce --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/sandbox/index.mdx @@ -0,0 +1,139 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all sandboxes, by default it list only running ones + +##### Usage + +```bash +e2b sandbox list [options] +``` + +##### Options + + + - `-s, --state : filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : filter by metadata, eg. key1=value1 ` + - `-l, --limit : limit the number of sandboxes returned ` + - `-f, --format : output format, eg. json, table ` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxIDs...] +``` + +##### Options + + + - `-a, --all: kill all sandboxes ` + - `-s, --state : when used with -a/--all flag, filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : when used with -a/--all flag, filter by metadata, eg. key1=value1 ` + + +## e2b sandbox create + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox create [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox spawn + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/template/index.mdx new file mode 100644 index 0000000000..84e1f54a46 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.1.0/template/index.mdx @@ -0,0 +1,139 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-f, --format : output format, eg. json, table ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/auth/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/auth/index.mdx new file mode 100644 index 0000000000..3062eb5af8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/auth/index.mdx @@ -0,0 +1,62 @@ +--- +title: Auth +--- + +## e2b auth + + +authentication commands + +##### Usage + +```bash +e2b auth [options] [command] +``` +## e2b auth login + + +log in to CLI + +##### Usage + +```bash +e2b auth login [options] +``` + + +## e2b auth logout + + +log out of CLI + +##### Usage + +```bash +e2b auth logout [options] +``` + + +## e2b auth info + + +get information about the current user + +##### Usage + +```bash +e2b auth info [options] +``` + + +## e2b auth configure + + +configure user + +##### Usage + +```bash +e2b auth configure [options] +``` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/sandbox/index.mdx new file mode 100644 index 0000000000..f36af22ab7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/sandbox/index.mdx @@ -0,0 +1,139 @@ +--- +title: Sandbox +--- + +## e2b sandbox + + +work with sandboxes + +##### Usage + +```bash +e2b sandbox [options] [command] +``` +## e2b sandbox connect + + +connect terminal to already running sandbox + +##### Usage + +```bash +e2b sandbox connect [options] +``` + + +## e2b sandbox list + + +list all sandboxes, by default it list only running ones + +##### Usage + +```bash +e2b sandbox list [options] +``` + +##### Options + + + - `-s, --state : filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : filter by metadata, eg. key1=value1 ` + - `-l, --limit : limit the number of sandboxes returned ` + - `-f, --format : output format, eg. json, pretty ` + + +## e2b sandbox kill + + +kill sandbox + +##### Usage + +```bash +e2b sandbox kill [options] [sandboxIDs...] +``` + +##### Options + + + - `-a, --all: kill all sandboxes ` + - `-s, --state : when used with -a/--all flag, filter by state, eg. running, paused. Defaults to running ` + - `-m, --metadata : when used with -a/--all flag, filter by metadata, eg. key1=value1 ` + + +## e2b sandbox create + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox create [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox spawn + + +create sandbox and connect terminal to it + +##### Usage + +```bash +e2b sandbox spawn [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + + +## e2b sandbox logs + + +show logs for sandbox + +##### Usage + +```bash +e2b sandbox logs [options] +``` + +##### Options + + + - `--level : filter logs by level (DEBUG, INFO, WARN, ERROR). The logs with the higher levels will be also shown. [default: INFO]` + - `-f, --follow: keep streaming logs until the sandbox is closed ` + - `--format : specify format for printing logs (json, pretty) [default: pretty]` + - `--loggers [loggers]: filter logs by loggers. Specify multiple loggers by separating them with a comma. ` + + +## e2b sandbox metrics + + +show metrics for sandbox + +##### Usage + +```bash +e2b sandbox metrics [options] +``` + +##### Options + + + - `-f, --follow: keep streaming metrics until the sandbox is closed ` + - `--format : specify format for printing metrics (json, pretty) [default: pretty]` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/template/index.mdx new file mode 100644 index 0000000000..61a4dc7981 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/cli/v2.2.0/template/index.mdx @@ -0,0 +1,139 @@ +--- +title: Template +--- + +## e2b template + + +manage sandbox templates + +##### Usage + +```bash +e2b template [options] [command] +``` +## e2b template build + + +build sandbox template defined by ./e2b.Dockerfile or ./Dockerfile in root directory. By default the root directory is the current working directory. This command also creates e2b.toml config. + +##### Usage + +```bash +e2b template build [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `-d, --dockerfile : specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` + - `-n, --name : specify sandbox template name. You can use the template name to start the sandbox with SDK. The template name must be lowercase and contain only letters, numbers, dashes and underscores. ` + - `-c, --cmd : specify command that will be executed when the sandbox is started. ` + - `--ready-cmd : specify command that will need to exit 0 for the template to be ready. ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `--cpu-count : specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` + - `--memory-mb : specify the amount of memory in megabytes that will be used to run the sandbox. Must be an even number. The default value is 512. ` + - `--build-arg : specify additional build arguments for the build command. The format should be =. ` + - `--no-cache: skip cache when building the template. ` + + +## e2b template list + + +list sandbox templates + +##### Usage + +```bash +e2b template list [options] +``` + +##### Options + + + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-f, --format : output format, eg. json, pretty ` + + +## e2b template init + + +create basic E2B Dockerfile (./e2b.Dockerfile) in root directory. You can then run e2b template build to build sandbox template from this Dockerfile + +##### Usage + +```bash +e2b template init [options] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + + +## e2b template delete + + +delete sandbox template and e2b.toml config + +##### Usage + +```bash +e2b template delete [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual delete confirmation ` + + +## e2b template publish + + +publish sandbox template + +##### Usage + +```bash +e2b template publish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual publish confirmation ` + + +## e2b template unpublish + + +unpublish sandbox template + +##### Usage + +```bash +e2b template unpublish [options] [template] +``` + +##### Options + + + - `-p, --path : change root directory where command is executed to directory ` + - `--config : specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` + - `-s, --select: select sandbox template from interactive list ` + - `-t, --team : specify the team ID that the operation will be associated with. You can find team ID in the team settings in the E2B dashboard (https://e2b.dev/dashboard?tab=team). ` + - `-y, --yes: skip manual unpublish confirmation ` + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/index.mdx new file mode 100644 index 0000000000..8959d67836 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/index.mdx @@ -0,0 +1,244 @@ +--- +title: Charts +--- + +### ChartType + +Chart types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `BAR` | `"bar"` | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | +| `LINE` | `"line"` | +| `PIE` | `"pie"` | +| `SCATTER` | `"scatter"` | +| `SUPERCHART` | `"superchart"` | +| `UNKNOWN` | `"unknown"` | + +*** + +### ScaleType + +Ax scale types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `ASINH` | `"asinh"` | +| `CATEGORICAL` | `"categorical"` | +| `DATETIME` | `"datetime"` | +| `FUNCTION` | `"function"` | +| `FUNCTIONLOG` | `"functionlog"` | +| `LINEAR` | `"linear"` | +| `LOG` | `"log"` | +| `LOGIT` | `"logit"` | +| `SYMLOG` | `"symlog"` | + +## Type Aliases + +### BarChart + +```ts +type BarChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BarData`[] | +| `type` | `ChartType.BAR` | + +*** + +### BarData + +```ts +type BarData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `group` | `string` | +| `label` | `string` | +| `value` | `string` | + +*** + +### BoxAndWhiskerChart + +```ts +type BoxAndWhiskerChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BoxAndWhiskerData`[] | +| `type` | `ChartType.BOX_AND_WHISKER` | + +*** + +### BoxAndWhiskerData + +```ts +type BoxAndWhiskerData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `first_quartile` | `number` | +| `label` | `string` | +| `max` | `number` | +| `median` | `number` | +| `min` | `number` | +| `outliers` | `number`[] | +| `third_quartile` | `number` | + +*** + +### Chart + +```ts +type Chart: object; +``` + +Represents a chart. + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `any`[] | +| `title` | `string` | +| `type` | `ChartType` | + +*** + +### ChartTypes + +```ts +type ChartTypes: + | LineChart + | ScatterChart + | BarChart + | PieChart + | BoxAndWhiskerChart + | SuperChart; +``` + +*** + +### LineChart + +```ts +type LineChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.LINE` | + +*** + +### PieChart + +```ts +type PieChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `PieData`[] | +| `type` | `ChartType.PIE` | + +*** + +### PieData + +```ts +type PieData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `angle` | `number` | +| `label` | `string` | +| `radius` | `number` | + +*** + +### PointData + +```ts +type PointData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `label` | `string` | +| `points` | [`number` \| `string`, `number` \| `string`][] | + +*** + +### ScatterChart + +```ts +type ScatterChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.SCATTER` | + +*** + +### SuperChart + +```ts +type SuperChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `Chart`[] | +| `type` | `ChartType.SUPERCHART` | + +## Functions + +### deserializeChart() + +```ts +function deserializeChart(data: any): Chart +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `any` | + +#### Returns + +`Chart` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/index.mdx new file mode 100644 index 0000000000..71f5db34eb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/index.mdx @@ -0,0 +1,17 @@ +--- +title: Consts +--- + +### DEFAULT\_TIMEOUT\_MS + +```ts +const DEFAULT_TIMEOUT_MS: 60000 = 60_000; +``` + +*** + +### JUPYTER\_PORT + +```ts +const JUPYTER_PORT: 49999 = 49999; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/index/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/index/index.mdx new file mode 100644 index 0000000000..cb35ea04d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/index/index.mdx @@ -0,0 +1,107 @@ +--- +title: Index +--- + +### BarChart + +Re-exports BarChart + +### BarData + +Re-exports BarData + +### BoxAndWhiskerChart + +Re-exports BoxAndWhiskerChart + +### BoxAndWhiskerData + +Re-exports BoxAndWhiskerData + +### Chart + +Re-exports Chart + +### ChartType + +Re-exports ChartType + +### ChartTypes + +Re-exports ChartTypes + +### Context + +Re-exports Context + +### CreateCodeContextOpts + +Re-exports CreateCodeContextOpts + +### default + +Renames and re-exports Sandbox + +### Execution + +Re-exports Execution + +### ExecutionError + +Re-exports ExecutionError + +### LineChart + +Re-exports LineChart + +### Logs + +Re-exports Logs + +### MIMEType + +Re-exports MIMEType + +### OutputMessage + +Re-exports OutputMessage + +### PieChart + +Re-exports PieChart + +### PieData + +Re-exports PieData + +### PointData + +Re-exports PointData + +### RawData + +Re-exports RawData + +### Result + +Re-exports Result + +### RunCodeOpts + +Re-exports RunCodeOpts + +### Sandbox + +Re-exports Sandbox + +### ScaleType + +Re-exports ScaleType + +### ScatterChart + +Re-exports ScatterChart + +### SuperChart + +Re-exports SuperChart diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/index.mdx new file mode 100644 index 0000000000..f43428a047 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/index.mdx @@ -0,0 +1,330 @@ +--- +title: Messaging +--- + +### Execution + +Represents the result of a cell execution. + +#### Constructors + +```ts +new Execution( + results: Result[], + logs: Logs, + error?: ExecutionError, + executionCount?: number): Execution +``` + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `results` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | +| `logs` | `Logs` | `...` | Logs printed to stdout and stderr during execution. | +| `error`? | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount`? | `number` | `undefined` | Execution count of the cell. | + +###### Returns + +`Execution` + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| ------ | ------ | ------ | ------ | ------ | +| `error?` | `public` | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount?` | `public` | `number` | `undefined` | Execution count of the cell. | +| `logs` | `public` | `Logs` | `undefined` | Logs printed to stdout and stderr during execution. | +| `results` | `public` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | + +#### Accessors + +### text + +```ts +get text(): undefined | string +``` + +Returns the text representation of the main result of the cell. + +###### Returns + +`undefined` \| `string` + +#### Methods + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the execution result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `error` | `undefined` \| `ExecutionError` | +| `logs` | `Logs` | +| `results` | `Result`[] | + +*** + +### ExecutionError + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + +#### Constructors + +```ts +new ExecutionError( + name: string, + value: string, + traceback: string): ExecutionError +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | Name of the error. | +| `value` | `string` | Value of the error. | +| `traceback` | `string` | The raw traceback of the error. | + +###### Returns + +`ExecutionError` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `name` | `public` | `string` | Name of the error. | +| `traceback` | `public` | `string` | The raw traceback of the error. | +| `value` | `public` | `string` | Value of the error. | + +*** + +### OutputMessage + +Represents an output message from the sandbox code execution. + +#### Constructors + +```ts +new OutputMessage( + line: string, + timestamp: number, + error: boolean): OutputMessage +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `line` | `string` | The output line. | +| `timestamp` | `number` | Unix epoch in nanoseconds. | +| `error` | `boolean` | Whether the output is an error. | + +###### Returns + +`OutputMessage` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | `boolean` | Whether the output is an error. | +| `line` | `readonly` | `string` | The output line. | +| `timestamp` | `readonly` | `number` | Unix epoch in nanoseconds. | + +#### Methods + +### toString() + +```ts +toString(): string +``` + +###### Returns + +`string` + +*** + +### Result + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + +#### Constructors + +```ts +new Result(rawData: RawData, isMainResult: boolean): Result +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rawData` | `RawData` | +| `isMainResult` | `boolean` | + +###### Returns + +`Result` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `chart?` | `readonly` | `ChartTypes` | Contains the chart data. | +| `data?` | `readonly` | `Record`\<`string`, `unknown`\> | Contains the data from DataFrame. | +| `extra?` | `readonly` | `any` | Extra data that can be included. Not part of the standard types. | +| `html?` | `readonly` | `string` | HTML representation of the data. | +| `isMainResult` | `readonly` | `boolean` | - | +| `javascript?` | `readonly` | `string` | JavaScript representation of the data. | +| `jpeg?` | `readonly` | `string` | JPEG representation of the data. | +| `json?` | `readonly` | `string` | JSON representation of the data. | +| `latex?` | `readonly` | `string` | LaTeX representation of the data. | +| `markdown?` | `readonly` | `string` | Markdown representation of the data. | +| `pdf?` | `readonly` | `string` | PDF representation of the data. | +| `png?` | `readonly` | `string` | PNG representation of the data. | +| `raw` | `readonly` | `RawData` | - | +| `svg?` | `readonly` | `string` | SVG representation of the data. | +| `text?` | `readonly` | `string` | Text representation of the result. | + +#### Methods + +### formats() + +```ts +formats(): string[] +``` + +Returns all the formats available for the result. + +###### Returns + +`string`[] + +Array of strings representing the formats available for the result. + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `extra`? | `any` | +| `html` | `undefined` \| `string` | +| `javascript` | `undefined` \| `string` | +| `jpeg` | `undefined` \| `string` | +| `json` | `undefined` \| `string` | +| `latex` | `undefined` \| `string` | +| `markdown` | `undefined` \| `string` | +| `pdf` | `undefined` \| `string` | +| `png` | `undefined` \| `string` | +| `svg` | `undefined` \| `string` | +| `text` | `undefined` \| `string` | + +## Type Aliases + +### Logs + +```ts +type Logs: object; +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `stderr` | `string`[] | List of strings printed to stderr by prints, subprocesses, etc. | +| `stdout` | `string`[] | List of strings printed to stdout by prints, subprocesses, etc. | + +*** + +### MIMEType + +```ts +type MIMEType: string; +``` + +Represents a MIME type. + +*** + +### RawData + +```ts +type RawData: object & E2BData; +``` + +Dictionary that maps MIME types to their corresponding representations of the data. + +## Functions + +### extractError() + +```ts +function extractError(res: Response): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `Response` | + +#### Returns + +`Promise`\<`undefined` \| `SandboxError`\> + +*** + +### parseOutput() + +```ts +function parseOutput( + execution: Execution, + line: string, + onStdout?: (output: OutputMessage) => any, + onStderr?: (output: OutputMessage) => any, + onResult?: (data: Result) => any, +onError?: (error: ExecutionError) => any): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `execution` | `Execution` | +| `line` | `string` | +| `onStdout`? | (`output`: `OutputMessage`) => `any` | +| `onStderr`? | (`output`: `OutputMessage`) => `any` | +| `onResult`? | (`data`: `Result`) => `any` | +| `onError`? | (`error`: `ExecutionError`) => `any` | + +#### Returns + +`Promise`\<`void`\> diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/index.mdx new file mode 100644 index 0000000000..8bee4e3d24 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/index.mdx @@ -0,0 +1,316 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +``` + +#### Methods + +### createCodeContext() + +```ts +createCodeContext(opts?: CreateCodeContextOpts): Promise +``` + +Creates a new context to run code in. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CreateCodeContextOpts` | options for creating the context. | + +###### Returns + +`Promise`\<`Context`\> + +context object. + +### runCode() + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object + +## Interfaces + +### CreateCodeContextOpts + +Options for creating a code context. + +#### Properties + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the context. + +###### Default + +```ts +/home/user +``` + +### language? + +```ts +optional language: string; +``` + +Language for the context. + +###### Default + +```ts +python +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### RunCodeOpts + +Options for running code. + +#### Properties + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for code execution. + +###### Default + +```ts +{} +``` + +### onError()? + +```ts +optional onError: (error: ExecutionError) => any; +``` + +Callback for handling the `ExecutionError` object. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `ExecutionError` | + +###### Returns + +`any` + +### onResult()? + +```ts +optional onResult: (data: Result) => any; +``` + +Callback for handling the final execution result. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `Result` | + +###### Returns + +`any` + +### onStderr()? + +```ts +optional onStderr: (output: OutputMessage) => any; +``` + +Callback for handling stderr messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### onStdout()? + +```ts +optional onStdout: (output: OutputMessage) => any; +``` + +Callback for handling stdout messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the code execution in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +## Type Aliases + +### Context + +```ts +type Context: object; +``` + +Represents a context for code execution. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `cwd` | `string` | The working directory of the context. | +| `id` | `string` | The ID of the context. | +| `language` | `string` | The language of the context. | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/charts/index.mdx new file mode 100644 index 0000000000..8959d67836 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/charts/index.mdx @@ -0,0 +1,244 @@ +--- +title: Charts +--- + +### ChartType + +Chart types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `BAR` | `"bar"` | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | +| `LINE` | `"line"` | +| `PIE` | `"pie"` | +| `SCATTER` | `"scatter"` | +| `SUPERCHART` | `"superchart"` | +| `UNKNOWN` | `"unknown"` | + +*** + +### ScaleType + +Ax scale types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `ASINH` | `"asinh"` | +| `CATEGORICAL` | `"categorical"` | +| `DATETIME` | `"datetime"` | +| `FUNCTION` | `"function"` | +| `FUNCTIONLOG` | `"functionlog"` | +| `LINEAR` | `"linear"` | +| `LOG` | `"log"` | +| `LOGIT` | `"logit"` | +| `SYMLOG` | `"symlog"` | + +## Type Aliases + +### BarChart + +```ts +type BarChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BarData`[] | +| `type` | `ChartType.BAR` | + +*** + +### BarData + +```ts +type BarData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `group` | `string` | +| `label` | `string` | +| `value` | `string` | + +*** + +### BoxAndWhiskerChart + +```ts +type BoxAndWhiskerChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BoxAndWhiskerData`[] | +| `type` | `ChartType.BOX_AND_WHISKER` | + +*** + +### BoxAndWhiskerData + +```ts +type BoxAndWhiskerData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `first_quartile` | `number` | +| `label` | `string` | +| `max` | `number` | +| `median` | `number` | +| `min` | `number` | +| `outliers` | `number`[] | +| `third_quartile` | `number` | + +*** + +### Chart + +```ts +type Chart: object; +``` + +Represents a chart. + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `any`[] | +| `title` | `string` | +| `type` | `ChartType` | + +*** + +### ChartTypes + +```ts +type ChartTypes: + | LineChart + | ScatterChart + | BarChart + | PieChart + | BoxAndWhiskerChart + | SuperChart; +``` + +*** + +### LineChart + +```ts +type LineChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.LINE` | + +*** + +### PieChart + +```ts +type PieChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `PieData`[] | +| `type` | `ChartType.PIE` | + +*** + +### PieData + +```ts +type PieData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `angle` | `number` | +| `label` | `string` | +| `radius` | `number` | + +*** + +### PointData + +```ts +type PointData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `label` | `string` | +| `points` | [`number` \| `string`, `number` \| `string`][] | + +*** + +### ScatterChart + +```ts +type ScatterChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.SCATTER` | + +*** + +### SuperChart + +```ts +type SuperChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `Chart`[] | +| `type` | `ChartType.SUPERCHART` | + +## Functions + +### deserializeChart() + +```ts +function deserializeChart(data: any): Chart +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `any` | + +#### Returns + +`Chart` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/consts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/consts/index.mdx new file mode 100644 index 0000000000..71f5db34eb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/consts/index.mdx @@ -0,0 +1,17 @@ +--- +title: Consts +--- + +### DEFAULT\_TIMEOUT\_MS + +```ts +const DEFAULT_TIMEOUT_MS: 60000 = 60_000; +``` + +*** + +### JUPYTER\_PORT + +```ts +const JUPYTER_PORT: 49999 = 49999; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/index/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/index/index.mdx new file mode 100644 index 0000000000..cb35ea04d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/index/index.mdx @@ -0,0 +1,107 @@ +--- +title: Index +--- + +### BarChart + +Re-exports BarChart + +### BarData + +Re-exports BarData + +### BoxAndWhiskerChart + +Re-exports BoxAndWhiskerChart + +### BoxAndWhiskerData + +Re-exports BoxAndWhiskerData + +### Chart + +Re-exports Chart + +### ChartType + +Re-exports ChartType + +### ChartTypes + +Re-exports ChartTypes + +### Context + +Re-exports Context + +### CreateCodeContextOpts + +Re-exports CreateCodeContextOpts + +### default + +Renames and re-exports Sandbox + +### Execution + +Re-exports Execution + +### ExecutionError + +Re-exports ExecutionError + +### LineChart + +Re-exports LineChart + +### Logs + +Re-exports Logs + +### MIMEType + +Re-exports MIMEType + +### OutputMessage + +Re-exports OutputMessage + +### PieChart + +Re-exports PieChart + +### PieData + +Re-exports PieData + +### PointData + +Re-exports PointData + +### RawData + +Re-exports RawData + +### Result + +Re-exports Result + +### RunCodeOpts + +Re-exports RunCodeOpts + +### Sandbox + +Re-exports Sandbox + +### ScaleType + +Re-exports ScaleType + +### ScatterChart + +Re-exports ScatterChart + +### SuperChart + +Re-exports SuperChart diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/messaging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/messaging/index.mdx new file mode 100644 index 0000000000..f43428a047 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/messaging/index.mdx @@ -0,0 +1,330 @@ +--- +title: Messaging +--- + +### Execution + +Represents the result of a cell execution. + +#### Constructors + +```ts +new Execution( + results: Result[], + logs: Logs, + error?: ExecutionError, + executionCount?: number): Execution +``` + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `results` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | +| `logs` | `Logs` | `...` | Logs printed to stdout and stderr during execution. | +| `error`? | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount`? | `number` | `undefined` | Execution count of the cell. | + +###### Returns + +`Execution` + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| ------ | ------ | ------ | ------ | ------ | +| `error?` | `public` | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount?` | `public` | `number` | `undefined` | Execution count of the cell. | +| `logs` | `public` | `Logs` | `undefined` | Logs printed to stdout and stderr during execution. | +| `results` | `public` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | + +#### Accessors + +### text + +```ts +get text(): undefined | string +``` + +Returns the text representation of the main result of the cell. + +###### Returns + +`undefined` \| `string` + +#### Methods + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the execution result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `error` | `undefined` \| `ExecutionError` | +| `logs` | `Logs` | +| `results` | `Result`[] | + +*** + +### ExecutionError + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + +#### Constructors + +```ts +new ExecutionError( + name: string, + value: string, + traceback: string): ExecutionError +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | Name of the error. | +| `value` | `string` | Value of the error. | +| `traceback` | `string` | The raw traceback of the error. | + +###### Returns + +`ExecutionError` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `name` | `public` | `string` | Name of the error. | +| `traceback` | `public` | `string` | The raw traceback of the error. | +| `value` | `public` | `string` | Value of the error. | + +*** + +### OutputMessage + +Represents an output message from the sandbox code execution. + +#### Constructors + +```ts +new OutputMessage( + line: string, + timestamp: number, + error: boolean): OutputMessage +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `line` | `string` | The output line. | +| `timestamp` | `number` | Unix epoch in nanoseconds. | +| `error` | `boolean` | Whether the output is an error. | + +###### Returns + +`OutputMessage` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | `boolean` | Whether the output is an error. | +| `line` | `readonly` | `string` | The output line. | +| `timestamp` | `readonly` | `number` | Unix epoch in nanoseconds. | + +#### Methods + +### toString() + +```ts +toString(): string +``` + +###### Returns + +`string` + +*** + +### Result + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + +#### Constructors + +```ts +new Result(rawData: RawData, isMainResult: boolean): Result +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rawData` | `RawData` | +| `isMainResult` | `boolean` | + +###### Returns + +`Result` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `chart?` | `readonly` | `ChartTypes` | Contains the chart data. | +| `data?` | `readonly` | `Record`\<`string`, `unknown`\> | Contains the data from DataFrame. | +| `extra?` | `readonly` | `any` | Extra data that can be included. Not part of the standard types. | +| `html?` | `readonly` | `string` | HTML representation of the data. | +| `isMainResult` | `readonly` | `boolean` | - | +| `javascript?` | `readonly` | `string` | JavaScript representation of the data. | +| `jpeg?` | `readonly` | `string` | JPEG representation of the data. | +| `json?` | `readonly` | `string` | JSON representation of the data. | +| `latex?` | `readonly` | `string` | LaTeX representation of the data. | +| `markdown?` | `readonly` | `string` | Markdown representation of the data. | +| `pdf?` | `readonly` | `string` | PDF representation of the data. | +| `png?` | `readonly` | `string` | PNG representation of the data. | +| `raw` | `readonly` | `RawData` | - | +| `svg?` | `readonly` | `string` | SVG representation of the data. | +| `text?` | `readonly` | `string` | Text representation of the result. | + +#### Methods + +### formats() + +```ts +formats(): string[] +``` + +Returns all the formats available for the result. + +###### Returns + +`string`[] + +Array of strings representing the formats available for the result. + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `extra`? | `any` | +| `html` | `undefined` \| `string` | +| `javascript` | `undefined` \| `string` | +| `jpeg` | `undefined` \| `string` | +| `json` | `undefined` \| `string` | +| `latex` | `undefined` \| `string` | +| `markdown` | `undefined` \| `string` | +| `pdf` | `undefined` \| `string` | +| `png` | `undefined` \| `string` | +| `svg` | `undefined` \| `string` | +| `text` | `undefined` \| `string` | + +## Type Aliases + +### Logs + +```ts +type Logs: object; +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `stderr` | `string`[] | List of strings printed to stderr by prints, subprocesses, etc. | +| `stdout` | `string`[] | List of strings printed to stdout by prints, subprocesses, etc. | + +*** + +### MIMEType + +```ts +type MIMEType: string; +``` + +Represents a MIME type. + +*** + +### RawData + +```ts +type RawData: object & E2BData; +``` + +Dictionary that maps MIME types to their corresponding representations of the data. + +## Functions + +### extractError() + +```ts +function extractError(res: Response): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `Response` | + +#### Returns + +`Promise`\<`undefined` \| `SandboxError`\> + +*** + +### parseOutput() + +```ts +function parseOutput( + execution: Execution, + line: string, + onStdout?: (output: OutputMessage) => any, + onStderr?: (output: OutputMessage) => any, + onResult?: (data: Result) => any, +onError?: (error: ExecutionError) => any): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `execution` | `Execution` | +| `line` | `string` | +| `onStdout`? | (`output`: `OutputMessage`) => `any` | +| `onStderr`? | (`output`: `OutputMessage`) => `any` | +| `onResult`? | (`data`: `Result`) => `any` | +| `onError`? | (`error`: `ExecutionError`) => `any` | + +#### Returns + +`Promise`\<`void`\> diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/sandbox/index.mdx new file mode 100644 index 0000000000..8bee4e3d24 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.0/sandbox/index.mdx @@ -0,0 +1,316 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +``` + +#### Methods + +### createCodeContext() + +```ts +createCodeContext(opts?: CreateCodeContextOpts): Promise +``` + +Creates a new context to run code in. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CreateCodeContextOpts` | options for creating the context. | + +###### Returns + +`Promise`\<`Context`\> + +context object. + +### runCode() + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object + +## Interfaces + +### CreateCodeContextOpts + +Options for creating a code context. + +#### Properties + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the context. + +###### Default + +```ts +/home/user +``` + +### language? + +```ts +optional language: string; +``` + +Language for the context. + +###### Default + +```ts +python +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### RunCodeOpts + +Options for running code. + +#### Properties + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for code execution. + +###### Default + +```ts +{} +``` + +### onError()? + +```ts +optional onError: (error: ExecutionError) => any; +``` + +Callback for handling the `ExecutionError` object. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `ExecutionError` | + +###### Returns + +`any` + +### onResult()? + +```ts +optional onResult: (data: Result) => any; +``` + +Callback for handling the final execution result. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `Result` | + +###### Returns + +`any` + +### onStderr()? + +```ts +optional onStderr: (output: OutputMessage) => any; +``` + +Callback for handling stderr messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### onStdout()? + +```ts +optional onStdout: (output: OutputMessage) => any; +``` + +Callback for handling stdout messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the code execution in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +## Type Aliases + +### Context + +```ts +type Context: object; +``` + +Represents a context for code execution. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `cwd` | `string` | The working directory of the context. | +| `id` | `string` | The ID of the context. | +| `language` | `string` | The language of the context. | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/charts/index.mdx new file mode 100644 index 0000000000..8959d67836 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/charts/index.mdx @@ -0,0 +1,244 @@ +--- +title: Charts +--- + +### ChartType + +Chart types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `BAR` | `"bar"` | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | +| `LINE` | `"line"` | +| `PIE` | `"pie"` | +| `SCATTER` | `"scatter"` | +| `SUPERCHART` | `"superchart"` | +| `UNKNOWN` | `"unknown"` | + +*** + +### ScaleType + +Ax scale types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `ASINH` | `"asinh"` | +| `CATEGORICAL` | `"categorical"` | +| `DATETIME` | `"datetime"` | +| `FUNCTION` | `"function"` | +| `FUNCTIONLOG` | `"functionlog"` | +| `LINEAR` | `"linear"` | +| `LOG` | `"log"` | +| `LOGIT` | `"logit"` | +| `SYMLOG` | `"symlog"` | + +## Type Aliases + +### BarChart + +```ts +type BarChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BarData`[] | +| `type` | `ChartType.BAR` | + +*** + +### BarData + +```ts +type BarData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `group` | `string` | +| `label` | `string` | +| `value` | `string` | + +*** + +### BoxAndWhiskerChart + +```ts +type BoxAndWhiskerChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BoxAndWhiskerData`[] | +| `type` | `ChartType.BOX_AND_WHISKER` | + +*** + +### BoxAndWhiskerData + +```ts +type BoxAndWhiskerData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `first_quartile` | `number` | +| `label` | `string` | +| `max` | `number` | +| `median` | `number` | +| `min` | `number` | +| `outliers` | `number`[] | +| `third_quartile` | `number` | + +*** + +### Chart + +```ts +type Chart: object; +``` + +Represents a chart. + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `any`[] | +| `title` | `string` | +| `type` | `ChartType` | + +*** + +### ChartTypes + +```ts +type ChartTypes: + | LineChart + | ScatterChart + | BarChart + | PieChart + | BoxAndWhiskerChart + | SuperChart; +``` + +*** + +### LineChart + +```ts +type LineChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.LINE` | + +*** + +### PieChart + +```ts +type PieChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `PieData`[] | +| `type` | `ChartType.PIE` | + +*** + +### PieData + +```ts +type PieData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `angle` | `number` | +| `label` | `string` | +| `radius` | `number` | + +*** + +### PointData + +```ts +type PointData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `label` | `string` | +| `points` | [`number` \| `string`, `number` \| `string`][] | + +*** + +### ScatterChart + +```ts +type ScatterChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.SCATTER` | + +*** + +### SuperChart + +```ts +type SuperChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `Chart`[] | +| `type` | `ChartType.SUPERCHART` | + +## Functions + +### deserializeChart() + +```ts +function deserializeChart(data: any): Chart +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `any` | + +#### Returns + +`Chart` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/consts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/consts/index.mdx new file mode 100644 index 0000000000..71f5db34eb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/consts/index.mdx @@ -0,0 +1,17 @@ +--- +title: Consts +--- + +### DEFAULT\_TIMEOUT\_MS + +```ts +const DEFAULT_TIMEOUT_MS: 60000 = 60_000; +``` + +*** + +### JUPYTER\_PORT + +```ts +const JUPYTER_PORT: 49999 = 49999; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/index/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/index/index.mdx new file mode 100644 index 0000000000..cb35ea04d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/index/index.mdx @@ -0,0 +1,107 @@ +--- +title: Index +--- + +### BarChart + +Re-exports BarChart + +### BarData + +Re-exports BarData + +### BoxAndWhiskerChart + +Re-exports BoxAndWhiskerChart + +### BoxAndWhiskerData + +Re-exports BoxAndWhiskerData + +### Chart + +Re-exports Chart + +### ChartType + +Re-exports ChartType + +### ChartTypes + +Re-exports ChartTypes + +### Context + +Re-exports Context + +### CreateCodeContextOpts + +Re-exports CreateCodeContextOpts + +### default + +Renames and re-exports Sandbox + +### Execution + +Re-exports Execution + +### ExecutionError + +Re-exports ExecutionError + +### LineChart + +Re-exports LineChart + +### Logs + +Re-exports Logs + +### MIMEType + +Re-exports MIMEType + +### OutputMessage + +Re-exports OutputMessage + +### PieChart + +Re-exports PieChart + +### PieData + +Re-exports PieData + +### PointData + +Re-exports PointData + +### RawData + +Re-exports RawData + +### Result + +Re-exports Result + +### RunCodeOpts + +Re-exports RunCodeOpts + +### Sandbox + +Re-exports Sandbox + +### ScaleType + +Re-exports ScaleType + +### ScatterChart + +Re-exports ScatterChart + +### SuperChart + +Re-exports SuperChart diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/messaging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/messaging/index.mdx new file mode 100644 index 0000000000..f43428a047 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/messaging/index.mdx @@ -0,0 +1,330 @@ +--- +title: Messaging +--- + +### Execution + +Represents the result of a cell execution. + +#### Constructors + +```ts +new Execution( + results: Result[], + logs: Logs, + error?: ExecutionError, + executionCount?: number): Execution +``` + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `results` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | +| `logs` | `Logs` | `...` | Logs printed to stdout and stderr during execution. | +| `error`? | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount`? | `number` | `undefined` | Execution count of the cell. | + +###### Returns + +`Execution` + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| ------ | ------ | ------ | ------ | ------ | +| `error?` | `public` | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount?` | `public` | `number` | `undefined` | Execution count of the cell. | +| `logs` | `public` | `Logs` | `undefined` | Logs printed to stdout and stderr during execution. | +| `results` | `public` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | + +#### Accessors + +### text + +```ts +get text(): undefined | string +``` + +Returns the text representation of the main result of the cell. + +###### Returns + +`undefined` \| `string` + +#### Methods + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the execution result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `error` | `undefined` \| `ExecutionError` | +| `logs` | `Logs` | +| `results` | `Result`[] | + +*** + +### ExecutionError + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + +#### Constructors + +```ts +new ExecutionError( + name: string, + value: string, + traceback: string): ExecutionError +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | Name of the error. | +| `value` | `string` | Value of the error. | +| `traceback` | `string` | The raw traceback of the error. | + +###### Returns + +`ExecutionError` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `name` | `public` | `string` | Name of the error. | +| `traceback` | `public` | `string` | The raw traceback of the error. | +| `value` | `public` | `string` | Value of the error. | + +*** + +### OutputMessage + +Represents an output message from the sandbox code execution. + +#### Constructors + +```ts +new OutputMessage( + line: string, + timestamp: number, + error: boolean): OutputMessage +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `line` | `string` | The output line. | +| `timestamp` | `number` | Unix epoch in nanoseconds. | +| `error` | `boolean` | Whether the output is an error. | + +###### Returns + +`OutputMessage` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | `boolean` | Whether the output is an error. | +| `line` | `readonly` | `string` | The output line. | +| `timestamp` | `readonly` | `number` | Unix epoch in nanoseconds. | + +#### Methods + +### toString() + +```ts +toString(): string +``` + +###### Returns + +`string` + +*** + +### Result + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + +#### Constructors + +```ts +new Result(rawData: RawData, isMainResult: boolean): Result +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rawData` | `RawData` | +| `isMainResult` | `boolean` | + +###### Returns + +`Result` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `chart?` | `readonly` | `ChartTypes` | Contains the chart data. | +| `data?` | `readonly` | `Record`\<`string`, `unknown`\> | Contains the data from DataFrame. | +| `extra?` | `readonly` | `any` | Extra data that can be included. Not part of the standard types. | +| `html?` | `readonly` | `string` | HTML representation of the data. | +| `isMainResult` | `readonly` | `boolean` | - | +| `javascript?` | `readonly` | `string` | JavaScript representation of the data. | +| `jpeg?` | `readonly` | `string` | JPEG representation of the data. | +| `json?` | `readonly` | `string` | JSON representation of the data. | +| `latex?` | `readonly` | `string` | LaTeX representation of the data. | +| `markdown?` | `readonly` | `string` | Markdown representation of the data. | +| `pdf?` | `readonly` | `string` | PDF representation of the data. | +| `png?` | `readonly` | `string` | PNG representation of the data. | +| `raw` | `readonly` | `RawData` | - | +| `svg?` | `readonly` | `string` | SVG representation of the data. | +| `text?` | `readonly` | `string` | Text representation of the result. | + +#### Methods + +### formats() + +```ts +formats(): string[] +``` + +Returns all the formats available for the result. + +###### Returns + +`string`[] + +Array of strings representing the formats available for the result. + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `extra`? | `any` | +| `html` | `undefined` \| `string` | +| `javascript` | `undefined` \| `string` | +| `jpeg` | `undefined` \| `string` | +| `json` | `undefined` \| `string` | +| `latex` | `undefined` \| `string` | +| `markdown` | `undefined` \| `string` | +| `pdf` | `undefined` \| `string` | +| `png` | `undefined` \| `string` | +| `svg` | `undefined` \| `string` | +| `text` | `undefined` \| `string` | + +## Type Aliases + +### Logs + +```ts +type Logs: object; +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `stderr` | `string`[] | List of strings printed to stderr by prints, subprocesses, etc. | +| `stdout` | `string`[] | List of strings printed to stdout by prints, subprocesses, etc. | + +*** + +### MIMEType + +```ts +type MIMEType: string; +``` + +Represents a MIME type. + +*** + +### RawData + +```ts +type RawData: object & E2BData; +``` + +Dictionary that maps MIME types to their corresponding representations of the data. + +## Functions + +### extractError() + +```ts +function extractError(res: Response): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `Response` | + +#### Returns + +`Promise`\<`undefined` \| `SandboxError`\> + +*** + +### parseOutput() + +```ts +function parseOutput( + execution: Execution, + line: string, + onStdout?: (output: OutputMessage) => any, + onStderr?: (output: OutputMessage) => any, + onResult?: (data: Result) => any, +onError?: (error: ExecutionError) => any): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `execution` | `Execution` | +| `line` | `string` | +| `onStdout`? | (`output`: `OutputMessage`) => `any` | +| `onStderr`? | (`output`: `OutputMessage`) => `any` | +| `onResult`? | (`data`: `Result`) => `any` | +| `onError`? | (`error`: `ExecutionError`) => `any` | + +#### Returns + +`Promise`\<`void`\> diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/sandbox/index.mdx new file mode 100644 index 0000000000..8bee4e3d24 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.1.1/sandbox/index.mdx @@ -0,0 +1,316 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +``` + +#### Methods + +### createCodeContext() + +```ts +createCodeContext(opts?: CreateCodeContextOpts): Promise +``` + +Creates a new context to run code in. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CreateCodeContextOpts` | options for creating the context. | + +###### Returns + +`Promise`\<`Context`\> + +context object. + +### runCode() + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object + +## Interfaces + +### CreateCodeContextOpts + +Options for creating a code context. + +#### Properties + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the context. + +###### Default + +```ts +/home/user +``` + +### language? + +```ts +optional language: string; +``` + +Language for the context. + +###### Default + +```ts +python +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### RunCodeOpts + +Options for running code. + +#### Properties + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for code execution. + +###### Default + +```ts +{} +``` + +### onError()? + +```ts +optional onError: (error: ExecutionError) => any; +``` + +Callback for handling the `ExecutionError` object. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `ExecutionError` | + +###### Returns + +`any` + +### onResult()? + +```ts +optional onResult: (data: Result) => any; +``` + +Callback for handling the final execution result. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `Result` | + +###### Returns + +`any` + +### onStderr()? + +```ts +optional onStderr: (output: OutputMessage) => any; +``` + +Callback for handling stderr messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### onStdout()? + +```ts +optional onStdout: (output: OutputMessage) => any; +``` + +Callback for handling stdout messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the code execution in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +## Type Aliases + +### Context + +```ts +type Context: object; +``` + +Represents a context for code execution. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `cwd` | `string` | The working directory of the context. | +| `id` | `string` | The ID of the context. | +| `language` | `string` | The language of the context. | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/charts/index.mdx new file mode 100644 index 0000000000..8959d67836 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/charts/index.mdx @@ -0,0 +1,244 @@ +--- +title: Charts +--- + +### ChartType + +Chart types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `BAR` | `"bar"` | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | +| `LINE` | `"line"` | +| `PIE` | `"pie"` | +| `SCATTER` | `"scatter"` | +| `SUPERCHART` | `"superchart"` | +| `UNKNOWN` | `"unknown"` | + +*** + +### ScaleType + +Ax scale types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `ASINH` | `"asinh"` | +| `CATEGORICAL` | `"categorical"` | +| `DATETIME` | `"datetime"` | +| `FUNCTION` | `"function"` | +| `FUNCTIONLOG` | `"functionlog"` | +| `LINEAR` | `"linear"` | +| `LOG` | `"log"` | +| `LOGIT` | `"logit"` | +| `SYMLOG` | `"symlog"` | + +## Type Aliases + +### BarChart + +```ts +type BarChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BarData`[] | +| `type` | `ChartType.BAR` | + +*** + +### BarData + +```ts +type BarData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `group` | `string` | +| `label` | `string` | +| `value` | `string` | + +*** + +### BoxAndWhiskerChart + +```ts +type BoxAndWhiskerChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BoxAndWhiskerData`[] | +| `type` | `ChartType.BOX_AND_WHISKER` | + +*** + +### BoxAndWhiskerData + +```ts +type BoxAndWhiskerData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `first_quartile` | `number` | +| `label` | `string` | +| `max` | `number` | +| `median` | `number` | +| `min` | `number` | +| `outliers` | `number`[] | +| `third_quartile` | `number` | + +*** + +### Chart + +```ts +type Chart: object; +``` + +Represents a chart. + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `any`[] | +| `title` | `string` | +| `type` | `ChartType` | + +*** + +### ChartTypes + +```ts +type ChartTypes: + | LineChart + | ScatterChart + | BarChart + | PieChart + | BoxAndWhiskerChart + | SuperChart; +``` + +*** + +### LineChart + +```ts +type LineChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.LINE` | + +*** + +### PieChart + +```ts +type PieChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `PieData`[] | +| `type` | `ChartType.PIE` | + +*** + +### PieData + +```ts +type PieData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `angle` | `number` | +| `label` | `string` | +| `radius` | `number` | + +*** + +### PointData + +```ts +type PointData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `label` | `string` | +| `points` | [`number` \| `string`, `number` \| `string`][] | + +*** + +### ScatterChart + +```ts +type ScatterChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.SCATTER` | + +*** + +### SuperChart + +```ts +type SuperChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `Chart`[] | +| `type` | `ChartType.SUPERCHART` | + +## Functions + +### deserializeChart() + +```ts +function deserializeChart(data: any): Chart +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `any` | + +#### Returns + +`Chart` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/consts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/consts/index.mdx new file mode 100644 index 0000000000..71f5db34eb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/consts/index.mdx @@ -0,0 +1,17 @@ +--- +title: Consts +--- + +### DEFAULT\_TIMEOUT\_MS + +```ts +const DEFAULT_TIMEOUT_MS: 60000 = 60_000; +``` + +*** + +### JUPYTER\_PORT + +```ts +const JUPYTER_PORT: 49999 = 49999; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/index/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/index/index.mdx new file mode 100644 index 0000000000..cb35ea04d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/index/index.mdx @@ -0,0 +1,107 @@ +--- +title: Index +--- + +### BarChart + +Re-exports BarChart + +### BarData + +Re-exports BarData + +### BoxAndWhiskerChart + +Re-exports BoxAndWhiskerChart + +### BoxAndWhiskerData + +Re-exports BoxAndWhiskerData + +### Chart + +Re-exports Chart + +### ChartType + +Re-exports ChartType + +### ChartTypes + +Re-exports ChartTypes + +### Context + +Re-exports Context + +### CreateCodeContextOpts + +Re-exports CreateCodeContextOpts + +### default + +Renames and re-exports Sandbox + +### Execution + +Re-exports Execution + +### ExecutionError + +Re-exports ExecutionError + +### LineChart + +Re-exports LineChart + +### Logs + +Re-exports Logs + +### MIMEType + +Re-exports MIMEType + +### OutputMessage + +Re-exports OutputMessage + +### PieChart + +Re-exports PieChart + +### PieData + +Re-exports PieData + +### PointData + +Re-exports PointData + +### RawData + +Re-exports RawData + +### Result + +Re-exports Result + +### RunCodeOpts + +Re-exports RunCodeOpts + +### Sandbox + +Re-exports Sandbox + +### ScaleType + +Re-exports ScaleType + +### ScatterChart + +Re-exports ScatterChart + +### SuperChart + +Re-exports SuperChart diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/messaging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/messaging/index.mdx new file mode 100644 index 0000000000..f43428a047 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/messaging/index.mdx @@ -0,0 +1,330 @@ +--- +title: Messaging +--- + +### Execution + +Represents the result of a cell execution. + +#### Constructors + +```ts +new Execution( + results: Result[], + logs: Logs, + error?: ExecutionError, + executionCount?: number): Execution +``` + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `results` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | +| `logs` | `Logs` | `...` | Logs printed to stdout and stderr during execution. | +| `error`? | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount`? | `number` | `undefined` | Execution count of the cell. | + +###### Returns + +`Execution` + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| ------ | ------ | ------ | ------ | ------ | +| `error?` | `public` | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount?` | `public` | `number` | `undefined` | Execution count of the cell. | +| `logs` | `public` | `Logs` | `undefined` | Logs printed to stdout and stderr during execution. | +| `results` | `public` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | + +#### Accessors + +### text + +```ts +get text(): undefined | string +``` + +Returns the text representation of the main result of the cell. + +###### Returns + +`undefined` \| `string` + +#### Methods + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the execution result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `error` | `undefined` \| `ExecutionError` | +| `logs` | `Logs` | +| `results` | `Result`[] | + +*** + +### ExecutionError + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + +#### Constructors + +```ts +new ExecutionError( + name: string, + value: string, + traceback: string): ExecutionError +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | Name of the error. | +| `value` | `string` | Value of the error. | +| `traceback` | `string` | The raw traceback of the error. | + +###### Returns + +`ExecutionError` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `name` | `public` | `string` | Name of the error. | +| `traceback` | `public` | `string` | The raw traceback of the error. | +| `value` | `public` | `string` | Value of the error. | + +*** + +### OutputMessage + +Represents an output message from the sandbox code execution. + +#### Constructors + +```ts +new OutputMessage( + line: string, + timestamp: number, + error: boolean): OutputMessage +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `line` | `string` | The output line. | +| `timestamp` | `number` | Unix epoch in nanoseconds. | +| `error` | `boolean` | Whether the output is an error. | + +###### Returns + +`OutputMessage` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | `boolean` | Whether the output is an error. | +| `line` | `readonly` | `string` | The output line. | +| `timestamp` | `readonly` | `number` | Unix epoch in nanoseconds. | + +#### Methods + +### toString() + +```ts +toString(): string +``` + +###### Returns + +`string` + +*** + +### Result + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + +#### Constructors + +```ts +new Result(rawData: RawData, isMainResult: boolean): Result +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rawData` | `RawData` | +| `isMainResult` | `boolean` | + +###### Returns + +`Result` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `chart?` | `readonly` | `ChartTypes` | Contains the chart data. | +| `data?` | `readonly` | `Record`\<`string`, `unknown`\> | Contains the data from DataFrame. | +| `extra?` | `readonly` | `any` | Extra data that can be included. Not part of the standard types. | +| `html?` | `readonly` | `string` | HTML representation of the data. | +| `isMainResult` | `readonly` | `boolean` | - | +| `javascript?` | `readonly` | `string` | JavaScript representation of the data. | +| `jpeg?` | `readonly` | `string` | JPEG representation of the data. | +| `json?` | `readonly` | `string` | JSON representation of the data. | +| `latex?` | `readonly` | `string` | LaTeX representation of the data. | +| `markdown?` | `readonly` | `string` | Markdown representation of the data. | +| `pdf?` | `readonly` | `string` | PDF representation of the data. | +| `png?` | `readonly` | `string` | PNG representation of the data. | +| `raw` | `readonly` | `RawData` | - | +| `svg?` | `readonly` | `string` | SVG representation of the data. | +| `text?` | `readonly` | `string` | Text representation of the result. | + +#### Methods + +### formats() + +```ts +formats(): string[] +``` + +Returns all the formats available for the result. + +###### Returns + +`string`[] + +Array of strings representing the formats available for the result. + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `extra`? | `any` | +| `html` | `undefined` \| `string` | +| `javascript` | `undefined` \| `string` | +| `jpeg` | `undefined` \| `string` | +| `json` | `undefined` \| `string` | +| `latex` | `undefined` \| `string` | +| `markdown` | `undefined` \| `string` | +| `pdf` | `undefined` \| `string` | +| `png` | `undefined` \| `string` | +| `svg` | `undefined` \| `string` | +| `text` | `undefined` \| `string` | + +## Type Aliases + +### Logs + +```ts +type Logs: object; +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `stderr` | `string`[] | List of strings printed to stderr by prints, subprocesses, etc. | +| `stdout` | `string`[] | List of strings printed to stdout by prints, subprocesses, etc. | + +*** + +### MIMEType + +```ts +type MIMEType: string; +``` + +Represents a MIME type. + +*** + +### RawData + +```ts +type RawData: object & E2BData; +``` + +Dictionary that maps MIME types to their corresponding representations of the data. + +## Functions + +### extractError() + +```ts +function extractError(res: Response): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `Response` | + +#### Returns + +`Promise`\<`undefined` \| `SandboxError`\> + +*** + +### parseOutput() + +```ts +function parseOutput( + execution: Execution, + line: string, + onStdout?: (output: OutputMessage) => any, + onStderr?: (output: OutputMessage) => any, + onResult?: (data: Result) => any, +onError?: (error: ExecutionError) => any): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `execution` | `Execution` | +| `line` | `string` | +| `onStdout`? | (`output`: `OutputMessage`) => `any` | +| `onStderr`? | (`output`: `OutputMessage`) => `any` | +| `onResult`? | (`data`: `Result`) => `any` | +| `onError`? | (`error`: `ExecutionError`) => `any` | + +#### Returns + +`Promise`\<`void`\> diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/sandbox/index.mdx new file mode 100644 index 0000000000..8bee4e3d24 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.2.0/sandbox/index.mdx @@ -0,0 +1,316 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +``` + +#### Methods + +### createCodeContext() + +```ts +createCodeContext(opts?: CreateCodeContextOpts): Promise +``` + +Creates a new context to run code in. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CreateCodeContextOpts` | options for creating the context. | + +###### Returns + +`Promise`\<`Context`\> + +context object. + +### runCode() + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object + +## Interfaces + +### CreateCodeContextOpts + +Options for creating a code context. + +#### Properties + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the context. + +###### Default + +```ts +/home/user +``` + +### language? + +```ts +optional language: string; +``` + +Language for the context. + +###### Default + +```ts +python +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### RunCodeOpts + +Options for running code. + +#### Properties + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for code execution. + +###### Default + +```ts +{} +``` + +### onError()? + +```ts +optional onError: (error: ExecutionError) => any; +``` + +Callback for handling the `ExecutionError` object. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `ExecutionError` | + +###### Returns + +`any` + +### onResult()? + +```ts +optional onResult: (data: Result) => any; +``` + +Callback for handling the final execution result. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `Result` | + +###### Returns + +`any` + +### onStderr()? + +```ts +optional onStderr: (output: OutputMessage) => any; +``` + +Callback for handling stderr messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### onStdout()? + +```ts +optional onStdout: (output: OutputMessage) => any; +``` + +Callback for handling stdout messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the code execution in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +## Type Aliases + +### Context + +```ts +type Context: object; +``` + +Represents a context for code execution. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `cwd` | `string` | The working directory of the context. | +| `id` | `string` | The ID of the context. | +| `language` | `string` | The language of the context. | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/charts/index.mdx new file mode 100644 index 0000000000..8959d67836 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/charts/index.mdx @@ -0,0 +1,244 @@ +--- +title: Charts +--- + +### ChartType + +Chart types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `BAR` | `"bar"` | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | +| `LINE` | `"line"` | +| `PIE` | `"pie"` | +| `SCATTER` | `"scatter"` | +| `SUPERCHART` | `"superchart"` | +| `UNKNOWN` | `"unknown"` | + +*** + +### ScaleType + +Ax scale types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `ASINH` | `"asinh"` | +| `CATEGORICAL` | `"categorical"` | +| `DATETIME` | `"datetime"` | +| `FUNCTION` | `"function"` | +| `FUNCTIONLOG` | `"functionlog"` | +| `LINEAR` | `"linear"` | +| `LOG` | `"log"` | +| `LOGIT` | `"logit"` | +| `SYMLOG` | `"symlog"` | + +## Type Aliases + +### BarChart + +```ts +type BarChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BarData`[] | +| `type` | `ChartType.BAR` | + +*** + +### BarData + +```ts +type BarData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `group` | `string` | +| `label` | `string` | +| `value` | `string` | + +*** + +### BoxAndWhiskerChart + +```ts +type BoxAndWhiskerChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BoxAndWhiskerData`[] | +| `type` | `ChartType.BOX_AND_WHISKER` | + +*** + +### BoxAndWhiskerData + +```ts +type BoxAndWhiskerData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `first_quartile` | `number` | +| `label` | `string` | +| `max` | `number` | +| `median` | `number` | +| `min` | `number` | +| `outliers` | `number`[] | +| `third_quartile` | `number` | + +*** + +### Chart + +```ts +type Chart: object; +``` + +Represents a chart. + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `any`[] | +| `title` | `string` | +| `type` | `ChartType` | + +*** + +### ChartTypes + +```ts +type ChartTypes: + | LineChart + | ScatterChart + | BarChart + | PieChart + | BoxAndWhiskerChart + | SuperChart; +``` + +*** + +### LineChart + +```ts +type LineChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.LINE` | + +*** + +### PieChart + +```ts +type PieChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `PieData`[] | +| `type` | `ChartType.PIE` | + +*** + +### PieData + +```ts +type PieData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `angle` | `number` | +| `label` | `string` | +| `radius` | `number` | + +*** + +### PointData + +```ts +type PointData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `label` | `string` | +| `points` | [`number` \| `string`, `number` \| `string`][] | + +*** + +### ScatterChart + +```ts +type ScatterChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.SCATTER` | + +*** + +### SuperChart + +```ts +type SuperChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `Chart`[] | +| `type` | `ChartType.SUPERCHART` | + +## Functions + +### deserializeChart() + +```ts +function deserializeChart(data: any): Chart +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `any` | + +#### Returns + +`Chart` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/consts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/consts/index.mdx new file mode 100644 index 0000000000..71f5db34eb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/consts/index.mdx @@ -0,0 +1,17 @@ +--- +title: Consts +--- + +### DEFAULT\_TIMEOUT\_MS + +```ts +const DEFAULT_TIMEOUT_MS: 60000 = 60_000; +``` + +*** + +### JUPYTER\_PORT + +```ts +const JUPYTER_PORT: 49999 = 49999; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/index/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/index/index.mdx new file mode 100644 index 0000000000..cb35ea04d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/index/index.mdx @@ -0,0 +1,107 @@ +--- +title: Index +--- + +### BarChart + +Re-exports BarChart + +### BarData + +Re-exports BarData + +### BoxAndWhiskerChart + +Re-exports BoxAndWhiskerChart + +### BoxAndWhiskerData + +Re-exports BoxAndWhiskerData + +### Chart + +Re-exports Chart + +### ChartType + +Re-exports ChartType + +### ChartTypes + +Re-exports ChartTypes + +### Context + +Re-exports Context + +### CreateCodeContextOpts + +Re-exports CreateCodeContextOpts + +### default + +Renames and re-exports Sandbox + +### Execution + +Re-exports Execution + +### ExecutionError + +Re-exports ExecutionError + +### LineChart + +Re-exports LineChart + +### Logs + +Re-exports Logs + +### MIMEType + +Re-exports MIMEType + +### OutputMessage + +Re-exports OutputMessage + +### PieChart + +Re-exports PieChart + +### PieData + +Re-exports PieData + +### PointData + +Re-exports PointData + +### RawData + +Re-exports RawData + +### Result + +Re-exports Result + +### RunCodeOpts + +Re-exports RunCodeOpts + +### Sandbox + +Re-exports Sandbox + +### ScaleType + +Re-exports ScaleType + +### ScatterChart + +Re-exports ScatterChart + +### SuperChart + +Re-exports SuperChart diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/messaging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/messaging/index.mdx new file mode 100644 index 0000000000..f43428a047 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/messaging/index.mdx @@ -0,0 +1,330 @@ +--- +title: Messaging +--- + +### Execution + +Represents the result of a cell execution. + +#### Constructors + +```ts +new Execution( + results: Result[], + logs: Logs, + error?: ExecutionError, + executionCount?: number): Execution +``` + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `results` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | +| `logs` | `Logs` | `...` | Logs printed to stdout and stderr during execution. | +| `error`? | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount`? | `number` | `undefined` | Execution count of the cell. | + +###### Returns + +`Execution` + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| ------ | ------ | ------ | ------ | ------ | +| `error?` | `public` | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount?` | `public` | `number` | `undefined` | Execution count of the cell. | +| `logs` | `public` | `Logs` | `undefined` | Logs printed to stdout and stderr during execution. | +| `results` | `public` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | + +#### Accessors + +### text + +```ts +get text(): undefined | string +``` + +Returns the text representation of the main result of the cell. + +###### Returns + +`undefined` \| `string` + +#### Methods + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the execution result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `error` | `undefined` \| `ExecutionError` | +| `logs` | `Logs` | +| `results` | `Result`[] | + +*** + +### ExecutionError + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + +#### Constructors + +```ts +new ExecutionError( + name: string, + value: string, + traceback: string): ExecutionError +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | Name of the error. | +| `value` | `string` | Value of the error. | +| `traceback` | `string` | The raw traceback of the error. | + +###### Returns + +`ExecutionError` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `name` | `public` | `string` | Name of the error. | +| `traceback` | `public` | `string` | The raw traceback of the error. | +| `value` | `public` | `string` | Value of the error. | + +*** + +### OutputMessage + +Represents an output message from the sandbox code execution. + +#### Constructors + +```ts +new OutputMessage( + line: string, + timestamp: number, + error: boolean): OutputMessage +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `line` | `string` | The output line. | +| `timestamp` | `number` | Unix epoch in nanoseconds. | +| `error` | `boolean` | Whether the output is an error. | + +###### Returns + +`OutputMessage` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | `boolean` | Whether the output is an error. | +| `line` | `readonly` | `string` | The output line. | +| `timestamp` | `readonly` | `number` | Unix epoch in nanoseconds. | + +#### Methods + +### toString() + +```ts +toString(): string +``` + +###### Returns + +`string` + +*** + +### Result + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + +#### Constructors + +```ts +new Result(rawData: RawData, isMainResult: boolean): Result +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rawData` | `RawData` | +| `isMainResult` | `boolean` | + +###### Returns + +`Result` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `chart?` | `readonly` | `ChartTypes` | Contains the chart data. | +| `data?` | `readonly` | `Record`\<`string`, `unknown`\> | Contains the data from DataFrame. | +| `extra?` | `readonly` | `any` | Extra data that can be included. Not part of the standard types. | +| `html?` | `readonly` | `string` | HTML representation of the data. | +| `isMainResult` | `readonly` | `boolean` | - | +| `javascript?` | `readonly` | `string` | JavaScript representation of the data. | +| `jpeg?` | `readonly` | `string` | JPEG representation of the data. | +| `json?` | `readonly` | `string` | JSON representation of the data. | +| `latex?` | `readonly` | `string` | LaTeX representation of the data. | +| `markdown?` | `readonly` | `string` | Markdown representation of the data. | +| `pdf?` | `readonly` | `string` | PDF representation of the data. | +| `png?` | `readonly` | `string` | PNG representation of the data. | +| `raw` | `readonly` | `RawData` | - | +| `svg?` | `readonly` | `string` | SVG representation of the data. | +| `text?` | `readonly` | `string` | Text representation of the result. | + +#### Methods + +### formats() + +```ts +formats(): string[] +``` + +Returns all the formats available for the result. + +###### Returns + +`string`[] + +Array of strings representing the formats available for the result. + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `extra`? | `any` | +| `html` | `undefined` \| `string` | +| `javascript` | `undefined` \| `string` | +| `jpeg` | `undefined` \| `string` | +| `json` | `undefined` \| `string` | +| `latex` | `undefined` \| `string` | +| `markdown` | `undefined` \| `string` | +| `pdf` | `undefined` \| `string` | +| `png` | `undefined` \| `string` | +| `svg` | `undefined` \| `string` | +| `text` | `undefined` \| `string` | + +## Type Aliases + +### Logs + +```ts +type Logs: object; +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `stderr` | `string`[] | List of strings printed to stderr by prints, subprocesses, etc. | +| `stdout` | `string`[] | List of strings printed to stdout by prints, subprocesses, etc. | + +*** + +### MIMEType + +```ts +type MIMEType: string; +``` + +Represents a MIME type. + +*** + +### RawData + +```ts +type RawData: object & E2BData; +``` + +Dictionary that maps MIME types to their corresponding representations of the data. + +## Functions + +### extractError() + +```ts +function extractError(res: Response): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `Response` | + +#### Returns + +`Promise`\<`undefined` \| `SandboxError`\> + +*** + +### parseOutput() + +```ts +function parseOutput( + execution: Execution, + line: string, + onStdout?: (output: OutputMessage) => any, + onStderr?: (output: OutputMessage) => any, + onResult?: (data: Result) => any, +onError?: (error: ExecutionError) => any): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `execution` | `Execution` | +| `line` | `string` | +| `onStdout`? | (`output`: `OutputMessage`) => `any` | +| `onStderr`? | (`output`: `OutputMessage`) => `any` | +| `onResult`? | (`data`: `Result`) => `any` | +| `onError`? | (`error`: `ExecutionError`) => `any` | + +#### Returns + +`Promise`\<`void`\> diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/sandbox/index.mdx new file mode 100644 index 0000000000..8bee4e3d24 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.0/sandbox/index.mdx @@ -0,0 +1,316 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +``` + +#### Methods + +### createCodeContext() + +```ts +createCodeContext(opts?: CreateCodeContextOpts): Promise +``` + +Creates a new context to run code in. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CreateCodeContextOpts` | options for creating the context. | + +###### Returns + +`Promise`\<`Context`\> + +context object. + +### runCode() + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object + +## Interfaces + +### CreateCodeContextOpts + +Options for creating a code context. + +#### Properties + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the context. + +###### Default + +```ts +/home/user +``` + +### language? + +```ts +optional language: string; +``` + +Language for the context. + +###### Default + +```ts +python +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### RunCodeOpts + +Options for running code. + +#### Properties + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for code execution. + +###### Default + +```ts +{} +``` + +### onError()? + +```ts +optional onError: (error: ExecutionError) => any; +``` + +Callback for handling the `ExecutionError` object. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `ExecutionError` | + +###### Returns + +`any` + +### onResult()? + +```ts +optional onResult: (data: Result) => any; +``` + +Callback for handling the final execution result. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `Result` | + +###### Returns + +`any` + +### onStderr()? + +```ts +optional onStderr: (output: OutputMessage) => any; +``` + +Callback for handling stderr messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### onStdout()? + +```ts +optional onStdout: (output: OutputMessage) => any; +``` + +Callback for handling stdout messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the code execution in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +## Type Aliases + +### Context + +```ts +type Context: object; +``` + +Represents a context for code execution. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `cwd` | `string` | The working directory of the context. | +| `id` | `string` | The ID of the context. | +| `language` | `string` | The language of the context. | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/charts/index.mdx new file mode 100644 index 0000000000..8959d67836 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/charts/index.mdx @@ -0,0 +1,244 @@ +--- +title: Charts +--- + +### ChartType + +Chart types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `BAR` | `"bar"` | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | +| `LINE` | `"line"` | +| `PIE` | `"pie"` | +| `SCATTER` | `"scatter"` | +| `SUPERCHART` | `"superchart"` | +| `UNKNOWN` | `"unknown"` | + +*** + +### ScaleType + +Ax scale types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `ASINH` | `"asinh"` | +| `CATEGORICAL` | `"categorical"` | +| `DATETIME` | `"datetime"` | +| `FUNCTION` | `"function"` | +| `FUNCTIONLOG` | `"functionlog"` | +| `LINEAR` | `"linear"` | +| `LOG` | `"log"` | +| `LOGIT` | `"logit"` | +| `SYMLOG` | `"symlog"` | + +## Type Aliases + +### BarChart + +```ts +type BarChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BarData`[] | +| `type` | `ChartType.BAR` | + +*** + +### BarData + +```ts +type BarData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `group` | `string` | +| `label` | `string` | +| `value` | `string` | + +*** + +### BoxAndWhiskerChart + +```ts +type BoxAndWhiskerChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BoxAndWhiskerData`[] | +| `type` | `ChartType.BOX_AND_WHISKER` | + +*** + +### BoxAndWhiskerData + +```ts +type BoxAndWhiskerData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `first_quartile` | `number` | +| `label` | `string` | +| `max` | `number` | +| `median` | `number` | +| `min` | `number` | +| `outliers` | `number`[] | +| `third_quartile` | `number` | + +*** + +### Chart + +```ts +type Chart: object; +``` + +Represents a chart. + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `any`[] | +| `title` | `string` | +| `type` | `ChartType` | + +*** + +### ChartTypes + +```ts +type ChartTypes: + | LineChart + | ScatterChart + | BarChart + | PieChart + | BoxAndWhiskerChart + | SuperChart; +``` + +*** + +### LineChart + +```ts +type LineChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.LINE` | + +*** + +### PieChart + +```ts +type PieChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `PieData`[] | +| `type` | `ChartType.PIE` | + +*** + +### PieData + +```ts +type PieData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `angle` | `number` | +| `label` | `string` | +| `radius` | `number` | + +*** + +### PointData + +```ts +type PointData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `label` | `string` | +| `points` | [`number` \| `string`, `number` \| `string`][] | + +*** + +### ScatterChart + +```ts +type ScatterChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.SCATTER` | + +*** + +### SuperChart + +```ts +type SuperChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `Chart`[] | +| `type` | `ChartType.SUPERCHART` | + +## Functions + +### deserializeChart() + +```ts +function deserializeChart(data: any): Chart +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `any` | + +#### Returns + +`Chart` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/consts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/consts/index.mdx new file mode 100644 index 0000000000..71f5db34eb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/consts/index.mdx @@ -0,0 +1,17 @@ +--- +title: Consts +--- + +### DEFAULT\_TIMEOUT\_MS + +```ts +const DEFAULT_TIMEOUT_MS: 60000 = 60_000; +``` + +*** + +### JUPYTER\_PORT + +```ts +const JUPYTER_PORT: 49999 = 49999; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/index/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/index/index.mdx new file mode 100644 index 0000000000..cb35ea04d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/index/index.mdx @@ -0,0 +1,107 @@ +--- +title: Index +--- + +### BarChart + +Re-exports BarChart + +### BarData + +Re-exports BarData + +### BoxAndWhiskerChart + +Re-exports BoxAndWhiskerChart + +### BoxAndWhiskerData + +Re-exports BoxAndWhiskerData + +### Chart + +Re-exports Chart + +### ChartType + +Re-exports ChartType + +### ChartTypes + +Re-exports ChartTypes + +### Context + +Re-exports Context + +### CreateCodeContextOpts + +Re-exports CreateCodeContextOpts + +### default + +Renames and re-exports Sandbox + +### Execution + +Re-exports Execution + +### ExecutionError + +Re-exports ExecutionError + +### LineChart + +Re-exports LineChart + +### Logs + +Re-exports Logs + +### MIMEType + +Re-exports MIMEType + +### OutputMessage + +Re-exports OutputMessage + +### PieChart + +Re-exports PieChart + +### PieData + +Re-exports PieData + +### PointData + +Re-exports PointData + +### RawData + +Re-exports RawData + +### Result + +Re-exports Result + +### RunCodeOpts + +Re-exports RunCodeOpts + +### Sandbox + +Re-exports Sandbox + +### ScaleType + +Re-exports ScaleType + +### ScatterChart + +Re-exports ScatterChart + +### SuperChart + +Re-exports SuperChart diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/messaging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/messaging/index.mdx new file mode 100644 index 0000000000..f43428a047 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/messaging/index.mdx @@ -0,0 +1,330 @@ +--- +title: Messaging +--- + +### Execution + +Represents the result of a cell execution. + +#### Constructors + +```ts +new Execution( + results: Result[], + logs: Logs, + error?: ExecutionError, + executionCount?: number): Execution +``` + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `results` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | +| `logs` | `Logs` | `...` | Logs printed to stdout and stderr during execution. | +| `error`? | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount`? | `number` | `undefined` | Execution count of the cell. | + +###### Returns + +`Execution` + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| ------ | ------ | ------ | ------ | ------ | +| `error?` | `public` | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount?` | `public` | `number` | `undefined` | Execution count of the cell. | +| `logs` | `public` | `Logs` | `undefined` | Logs printed to stdout and stderr during execution. | +| `results` | `public` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | + +#### Accessors + +### text + +```ts +get text(): undefined | string +``` + +Returns the text representation of the main result of the cell. + +###### Returns + +`undefined` \| `string` + +#### Methods + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the execution result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `error` | `undefined` \| `ExecutionError` | +| `logs` | `Logs` | +| `results` | `Result`[] | + +*** + +### ExecutionError + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + +#### Constructors + +```ts +new ExecutionError( + name: string, + value: string, + traceback: string): ExecutionError +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | Name of the error. | +| `value` | `string` | Value of the error. | +| `traceback` | `string` | The raw traceback of the error. | + +###### Returns + +`ExecutionError` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `name` | `public` | `string` | Name of the error. | +| `traceback` | `public` | `string` | The raw traceback of the error. | +| `value` | `public` | `string` | Value of the error. | + +*** + +### OutputMessage + +Represents an output message from the sandbox code execution. + +#### Constructors + +```ts +new OutputMessage( + line: string, + timestamp: number, + error: boolean): OutputMessage +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `line` | `string` | The output line. | +| `timestamp` | `number` | Unix epoch in nanoseconds. | +| `error` | `boolean` | Whether the output is an error. | + +###### Returns + +`OutputMessage` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | `boolean` | Whether the output is an error. | +| `line` | `readonly` | `string` | The output line. | +| `timestamp` | `readonly` | `number` | Unix epoch in nanoseconds. | + +#### Methods + +### toString() + +```ts +toString(): string +``` + +###### Returns + +`string` + +*** + +### Result + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + +#### Constructors + +```ts +new Result(rawData: RawData, isMainResult: boolean): Result +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rawData` | `RawData` | +| `isMainResult` | `boolean` | + +###### Returns + +`Result` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `chart?` | `readonly` | `ChartTypes` | Contains the chart data. | +| `data?` | `readonly` | `Record`\<`string`, `unknown`\> | Contains the data from DataFrame. | +| `extra?` | `readonly` | `any` | Extra data that can be included. Not part of the standard types. | +| `html?` | `readonly` | `string` | HTML representation of the data. | +| `isMainResult` | `readonly` | `boolean` | - | +| `javascript?` | `readonly` | `string` | JavaScript representation of the data. | +| `jpeg?` | `readonly` | `string` | JPEG representation of the data. | +| `json?` | `readonly` | `string` | JSON representation of the data. | +| `latex?` | `readonly` | `string` | LaTeX representation of the data. | +| `markdown?` | `readonly` | `string` | Markdown representation of the data. | +| `pdf?` | `readonly` | `string` | PDF representation of the data. | +| `png?` | `readonly` | `string` | PNG representation of the data. | +| `raw` | `readonly` | `RawData` | - | +| `svg?` | `readonly` | `string` | SVG representation of the data. | +| `text?` | `readonly` | `string` | Text representation of the result. | + +#### Methods + +### formats() + +```ts +formats(): string[] +``` + +Returns all the formats available for the result. + +###### Returns + +`string`[] + +Array of strings representing the formats available for the result. + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `extra`? | `any` | +| `html` | `undefined` \| `string` | +| `javascript` | `undefined` \| `string` | +| `jpeg` | `undefined` \| `string` | +| `json` | `undefined` \| `string` | +| `latex` | `undefined` \| `string` | +| `markdown` | `undefined` \| `string` | +| `pdf` | `undefined` \| `string` | +| `png` | `undefined` \| `string` | +| `svg` | `undefined` \| `string` | +| `text` | `undefined` \| `string` | + +## Type Aliases + +### Logs + +```ts +type Logs: object; +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `stderr` | `string`[] | List of strings printed to stderr by prints, subprocesses, etc. | +| `stdout` | `string`[] | List of strings printed to stdout by prints, subprocesses, etc. | + +*** + +### MIMEType + +```ts +type MIMEType: string; +``` + +Represents a MIME type. + +*** + +### RawData + +```ts +type RawData: object & E2BData; +``` + +Dictionary that maps MIME types to their corresponding representations of the data. + +## Functions + +### extractError() + +```ts +function extractError(res: Response): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `Response` | + +#### Returns + +`Promise`\<`undefined` \| `SandboxError`\> + +*** + +### parseOutput() + +```ts +function parseOutput( + execution: Execution, + line: string, + onStdout?: (output: OutputMessage) => any, + onStderr?: (output: OutputMessage) => any, + onResult?: (data: Result) => any, +onError?: (error: ExecutionError) => any): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `execution` | `Execution` | +| `line` | `string` | +| `onStdout`? | (`output`: `OutputMessage`) => `any` | +| `onStderr`? | (`output`: `OutputMessage`) => `any` | +| `onResult`? | (`data`: `Result`) => `any` | +| `onError`? | (`error`: `ExecutionError`) => `any` | + +#### Returns + +`Promise`\<`void`\> diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/sandbox/index.mdx new file mode 100644 index 0000000000..8bee4e3d24 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v1.5.1/sandbox/index.mdx @@ -0,0 +1,316 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +``` + +#### Methods + +### createCodeContext() + +```ts +createCodeContext(opts?: CreateCodeContextOpts): Promise +``` + +Creates a new context to run code in. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CreateCodeContextOpts` | options for creating the context. | + +###### Returns + +`Promise`\<`Context`\> + +context object. + +### runCode() + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object + +## Interfaces + +### CreateCodeContextOpts + +Options for creating a code context. + +#### Properties + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the context. + +###### Default + +```ts +/home/user +``` + +### language? + +```ts +optional language: string; +``` + +Language for the context. + +###### Default + +```ts +python +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### RunCodeOpts + +Options for running code. + +#### Properties + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for code execution. + +###### Default + +```ts +{} +``` + +### onError()? + +```ts +optional onError: (error: ExecutionError) => any; +``` + +Callback for handling the `ExecutionError` object. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `ExecutionError` | + +###### Returns + +`any` + +### onResult()? + +```ts +optional onResult: (data: Result) => any; +``` + +Callback for handling the final execution result. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `Result` | + +###### Returns + +`any` + +### onStderr()? + +```ts +optional onStderr: (output: OutputMessage) => any; +``` + +Callback for handling stderr messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### onStdout()? + +```ts +optional onStdout: (output: OutputMessage) => any; +``` + +Callback for handling stdout messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the code execution in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +## Type Aliases + +### Context + +```ts +type Context: object; +``` + +Represents a context for code execution. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `cwd` | `string` | The working directory of the context. | +| `id` | `string` | The ID of the context. | +| `language` | `string` | The language of the context. | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/charts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/charts/index.mdx new file mode 100644 index 0000000000..8959d67836 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/charts/index.mdx @@ -0,0 +1,244 @@ +--- +title: Charts +--- + +### ChartType + +Chart types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `BAR` | `"bar"` | +| `BOX_AND_WHISKER` | `"box_and_whisker"` | +| `LINE` | `"line"` | +| `PIE` | `"pie"` | +| `SCATTER` | `"scatter"` | +| `SUPERCHART` | `"superchart"` | +| `UNKNOWN` | `"unknown"` | + +*** + +### ScaleType + +Ax scale types + +#### Enumeration Members + +| Enumeration Member | Value | +| ------ | ------ | +| `ASINH` | `"asinh"` | +| `CATEGORICAL` | `"categorical"` | +| `DATETIME` | `"datetime"` | +| `FUNCTION` | `"function"` | +| `FUNCTIONLOG` | `"functionlog"` | +| `LINEAR` | `"linear"` | +| `LOG` | `"log"` | +| `LOGIT` | `"logit"` | +| `SYMLOG` | `"symlog"` | + +## Type Aliases + +### BarChart + +```ts +type BarChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BarData`[] | +| `type` | `ChartType.BAR` | + +*** + +### BarData + +```ts +type BarData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `group` | `string` | +| `label` | `string` | +| `value` | `string` | + +*** + +### BoxAndWhiskerChart + +```ts +type BoxAndWhiskerChart: Chart2D & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `BoxAndWhiskerData`[] | +| `type` | `ChartType.BOX_AND_WHISKER` | + +*** + +### BoxAndWhiskerData + +```ts +type BoxAndWhiskerData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `first_quartile` | `number` | +| `label` | `string` | +| `max` | `number` | +| `median` | `number` | +| `min` | `number` | +| `outliers` | `number`[] | +| `third_quartile` | `number` | + +*** + +### Chart + +```ts +type Chart: object; +``` + +Represents a chart. + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `any`[] | +| `title` | `string` | +| `type` | `ChartType` | + +*** + +### ChartTypes + +```ts +type ChartTypes: + | LineChart + | ScatterChart + | BarChart + | PieChart + | BoxAndWhiskerChart + | SuperChart; +``` + +*** + +### LineChart + +```ts +type LineChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.LINE` | + +*** + +### PieChart + +```ts +type PieChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `PieData`[] | +| `type` | `ChartType.PIE` | + +*** + +### PieData + +```ts +type PieData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `angle` | `number` | +| `label` | `string` | +| `radius` | `number` | + +*** + +### PointData + +```ts +type PointData: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `label` | `string` | +| `points` | [`number` \| `string`, `number` \| `string`][] | + +*** + +### ScatterChart + +```ts +type ScatterChart: PointChart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `type` | `ChartType.SCATTER` | + +*** + +### SuperChart + +```ts +type SuperChart: Chart & object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `elements` | `Chart`[] | +| `type` | `ChartType.SUPERCHART` | + +## Functions + +### deserializeChart() + +```ts +function deserializeChart(data: any): Chart +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `any` | + +#### Returns + +`Chart` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/consts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/consts/index.mdx new file mode 100644 index 0000000000..71f5db34eb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/consts/index.mdx @@ -0,0 +1,17 @@ +--- +title: Consts +--- + +### DEFAULT\_TIMEOUT\_MS + +```ts +const DEFAULT_TIMEOUT_MS: 60000 = 60_000; +``` + +*** + +### JUPYTER\_PORT + +```ts +const JUPYTER_PORT: 49999 = 49999; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/index/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/index/index.mdx new file mode 100644 index 0000000000..cb35ea04d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/index/index.mdx @@ -0,0 +1,107 @@ +--- +title: Index +--- + +### BarChart + +Re-exports BarChart + +### BarData + +Re-exports BarData + +### BoxAndWhiskerChart + +Re-exports BoxAndWhiskerChart + +### BoxAndWhiskerData + +Re-exports BoxAndWhiskerData + +### Chart + +Re-exports Chart + +### ChartType + +Re-exports ChartType + +### ChartTypes + +Re-exports ChartTypes + +### Context + +Re-exports Context + +### CreateCodeContextOpts + +Re-exports CreateCodeContextOpts + +### default + +Renames and re-exports Sandbox + +### Execution + +Re-exports Execution + +### ExecutionError + +Re-exports ExecutionError + +### LineChart + +Re-exports LineChart + +### Logs + +Re-exports Logs + +### MIMEType + +Re-exports MIMEType + +### OutputMessage + +Re-exports OutputMessage + +### PieChart + +Re-exports PieChart + +### PieData + +Re-exports PieData + +### PointData + +Re-exports PointData + +### RawData + +Re-exports RawData + +### Result + +Re-exports Result + +### RunCodeOpts + +Re-exports RunCodeOpts + +### Sandbox + +Re-exports Sandbox + +### ScaleType + +Re-exports ScaleType + +### ScatterChart + +Re-exports ScatterChart + +### SuperChart + +Re-exports SuperChart diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/messaging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/messaging/index.mdx new file mode 100644 index 0000000000..f43428a047 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/messaging/index.mdx @@ -0,0 +1,330 @@ +--- +title: Messaging +--- + +### Execution + +Represents the result of a cell execution. + +#### Constructors + +```ts +new Execution( + results: Result[], + logs: Logs, + error?: ExecutionError, + executionCount?: number): Execution +``` + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `results` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | +| `logs` | `Logs` | `...` | Logs printed to stdout and stderr during execution. | +| `error`? | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount`? | `number` | `undefined` | Execution count of the cell. | + +###### Returns + +`Execution` + +#### Properties + +| Property | Modifier | Type | Default value | Description | +| ------ | ------ | ------ | ------ | ------ | +| `error?` | `public` | `ExecutionError` | `undefined` | An Error object if an error occurred, null otherwise. | +| `executionCount?` | `public` | `number` | `undefined` | Execution count of the cell. | +| `logs` | `public` | `Logs` | `undefined` | Logs printed to stdout and stderr during execution. | +| `results` | `public` | `Result`[] | `[]` | List of result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). | + +#### Accessors + +### text + +```ts +get text(): undefined | string +``` + +Returns the text representation of the main result of the cell. + +###### Returns + +`undefined` \| `string` + +#### Methods + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the execution result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `error` | `undefined` \| `ExecutionError` | +| `logs` | `Logs` | +| `results` | `Result`[] | + +*** + +### ExecutionError + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + +#### Constructors + +```ts +new ExecutionError( + name: string, + value: string, + traceback: string): ExecutionError +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `name` | `string` | Name of the error. | +| `value` | `string` | Value of the error. | +| `traceback` | `string` | The raw traceback of the error. | + +###### Returns + +`ExecutionError` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `name` | `public` | `string` | Name of the error. | +| `traceback` | `public` | `string` | The raw traceback of the error. | +| `value` | `public` | `string` | Value of the error. | + +*** + +### OutputMessage + +Represents an output message from the sandbox code execution. + +#### Constructors + +```ts +new OutputMessage( + line: string, + timestamp: number, + error: boolean): OutputMessage +``` + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `line` | `string` | The output line. | +| `timestamp` | `number` | Unix epoch in nanoseconds. | +| `error` | `boolean` | Whether the output is an error. | + +###### Returns + +`OutputMessage` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `error` | `readonly` | `boolean` | Whether the output is an error. | +| `line` | `readonly` | `string` | The output line. | +| `timestamp` | `readonly` | `number` | Unix epoch in nanoseconds. | + +#### Methods + +### toString() + +```ts +toString(): string +``` + +###### Returns + +`string` + +*** + +### Result + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + +#### Constructors + +```ts +new Result(rawData: RawData, isMainResult: boolean): Result +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `rawData` | `RawData` | +| `isMainResult` | `boolean` | + +###### Returns + +`Result` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `chart?` | `readonly` | `ChartTypes` | Contains the chart data. | +| `data?` | `readonly` | `Record`\<`string`, `unknown`\> | Contains the data from DataFrame. | +| `extra?` | `readonly` | `any` | Extra data that can be included. Not part of the standard types. | +| `html?` | `readonly` | `string` | HTML representation of the data. | +| `isMainResult` | `readonly` | `boolean` | - | +| `javascript?` | `readonly` | `string` | JavaScript representation of the data. | +| `jpeg?` | `readonly` | `string` | JPEG representation of the data. | +| `json?` | `readonly` | `string` | JSON representation of the data. | +| `latex?` | `readonly` | `string` | LaTeX representation of the data. | +| `markdown?` | `readonly` | `string` | Markdown representation of the data. | +| `pdf?` | `readonly` | `string` | PDF representation of the data. | +| `png?` | `readonly` | `string` | PNG representation of the data. | +| `raw` | `readonly` | `RawData` | - | +| `svg?` | `readonly` | `string` | SVG representation of the data. | +| `text?` | `readonly` | `string` | Text representation of the result. | + +#### Methods + +### formats() + +```ts +formats(): string[] +``` + +Returns all the formats available for the result. + +###### Returns + +`string`[] + +Array of strings representing the formats available for the result. + +### toJSON() + +```ts +toJSON(): object +``` + +Returns the serializable representation of the result. + +###### Returns + +`object` + +| Name | Type | +| ------ | ------ | +| `extra`? | `any` | +| `html` | `undefined` \| `string` | +| `javascript` | `undefined` \| `string` | +| `jpeg` | `undefined` \| `string` | +| `json` | `undefined` \| `string` | +| `latex` | `undefined` \| `string` | +| `markdown` | `undefined` \| `string` | +| `pdf` | `undefined` \| `string` | +| `png` | `undefined` \| `string` | +| `svg` | `undefined` \| `string` | +| `text` | `undefined` \| `string` | + +## Type Aliases + +### Logs + +```ts +type Logs: object; +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `stderr` | `string`[] | List of strings printed to stderr by prints, subprocesses, etc. | +| `stdout` | `string`[] | List of strings printed to stdout by prints, subprocesses, etc. | + +*** + +### MIMEType + +```ts +type MIMEType: string; +``` + +Represents a MIME type. + +*** + +### RawData + +```ts +type RawData: object & E2BData; +``` + +Dictionary that maps MIME types to their corresponding representations of the data. + +## Functions + +### extractError() + +```ts +function extractError(res: Response): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `res` | `Response` | + +#### Returns + +`Promise`\<`undefined` \| `SandboxError`\> + +*** + +### parseOutput() + +```ts +function parseOutput( + execution: Execution, + line: string, + onStdout?: (output: OutputMessage) => any, + onStderr?: (output: OutputMessage) => any, + onResult?: (data: Result) => any, +onError?: (error: ExecutionError) => any): Promise +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `execution` | `Execution` | +| `line` | `string` | +| `onStdout`? | (`output`: `OutputMessage`) => `any` | +| `onStderr`? | (`output`: `OutputMessage`) => `any` | +| `onResult`? | (`data`: `Result`) => `any` | +| `onError`? | (`error`: `ExecutionError`) => `any` | + +#### Returns + +`Promise`\<`void`\> diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..8bee4e3d24 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-js-sdk/v2.0.0/sandbox/index.mdx @@ -0,0 +1,316 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from '@e2b/code-interpreter' + +const sandbox = await Sandbox.create() +``` + +#### Methods + +### createCodeContext() + +```ts +createCodeContext(opts?: CreateCodeContextOpts): Promise +``` + +Creates a new context to run code in. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CreateCodeContextOpts` | options for creating the context. | + +###### Returns + +`Promise`\<`Context`\> + +context object. + +### runCode() + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Run the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code. | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object. + +###### runCode(code, opts) + +```ts +runCode(code: string, opts?: RunCodeOpts & object): Promise +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `code` | `string` | code to execute. | +| `opts`? | `RunCodeOpts` & `object` | options for executing the code | + +###### Returns + +`Promise`\<`Execution`\> + +`Execution` result object + +## Interfaces + +### CreateCodeContextOpts + +Options for creating a code context. + +#### Properties + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the context. + +###### Default + +```ts +/home/user +``` + +### language? + +```ts +optional language: string; +``` + +Language for the context. + +###### Default + +```ts +python +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### RunCodeOpts + +Options for running code. + +#### Properties + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for code execution. + +###### Default + +```ts +{} +``` + +### onError()? + +```ts +optional onError: (error: ExecutionError) => any; +``` + +Callback for handling the `ExecutionError` object. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `error` | `ExecutionError` | + +###### Returns + +`any` + +### onResult()? + +```ts +optional onResult: (data: Result) => any; +``` + +Callback for handling the final execution result. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `Result` | + +###### Returns + +`any` + +### onStderr()? + +```ts +optional onStderr: (output: OutputMessage) => any; +``` + +Callback for handling stderr messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### onStdout()? + +```ts +optional onStdout: (output: OutputMessage) => any; +``` + +Callback for handling stdout messages. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `output` | `OutputMessage` | + +###### Returns + +`any` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for the request in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the code execution in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +## Type Aliases + +### Context + +```ts +type Context: object; +``` + +Represents a context for code execution. + +#### Type declaration + +| Name | Type | Description | +| ------ | ------ | ------ | +| `cwd` | `string` | The working directory of the context. | +| `id` | `string` | The ID of the context. | +| `language` | `string` | The language of the context. | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..5d65c408ca --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.1/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.2/sandbox/index.mdx new file mode 100644 index 0000000000..f7003e555a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.2/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.3/sandbox/index.mdx new file mode 100644 index 0000000000..fdddff5e0a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.3/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.4/sandbox/index.mdx new file mode 100644 index 0000000000..5d65c408ca --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.4/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.5/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.5/sandbox/index.mdx new file mode 100644 index 0000000000..16bfcb97e5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.0.5/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.0/sandbox/index.mdx new file mode 100644 index 0000000000..4322033e14 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.0/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.1/sandbox/index.mdx new file mode 100644 index 0000000000..4322033e14 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.1.1/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.0/sandbox/index.mdx new file mode 100644 index 0000000000..4322033e14 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.0/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.1/sandbox/index.mdx new file mode 100644 index 0000000000..829a22ec5c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.2.1/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.0/sandbox/index.mdx new file mode 100644 index 0000000000..a721916527 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.0/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.1/sandbox/index.mdx new file mode 100644 index 0000000000..a721916527 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.1/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + + + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.2/sandbox/index.mdx new file mode 100644 index 0000000000..54295403b5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v1.5.2/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v2.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v2.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..54b98fefb4 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/code-interpreter-python-sdk/v2.0.0/sandbox/index.mdx @@ -0,0 +1,726 @@ +--- +title: Sandbox +--- + + + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(BaseAsyncSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import AsyncSandbox +sandbox = await AsyncSandbox.create() +``` + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +async def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +async def create_code_context( + cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## Sandbox + +```python Python +class Sandbox(BaseSandbox) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b_code_interpreter import Sandbox + +sandbox = Sandbox.create() +``` + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Union[Literal["python"], None] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code as Python. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + language: Optional[str] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code for the specified language. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. +If no language is specified, Python is used. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `language`: Language to use for code execution. If not defined, the default Python context is used. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### run\_code + +```python Python +@overload +def run_code(code: str, + context: Optional[Context] = None, + on_stdout: Optional[OutputHandler[OutputMessage]] = None, + on_stderr: Optional[OutputHandler[OutputMessage]] = None, + on_result: Optional[OutputHandler[Result]] = None, + on_error: Optional[OutputHandler[ExecutionError]] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = None, + request_timeout: Optional[float] = None) -> Execution +``` + +Runs the code in the specified context, if not specified, the default context is used. + +Specify the `language` or `context` option to run the code as a different language or in a different `Context`. + +You can reference previously defined variables, imports, and functions in the code. + +**Arguments**: + +- `code`: Code to execute +- `context`: Concrete context to run the code in. If not specified, the default context for the language is used. It's mutually exclusive with the language. +- `on_stdout`: Callback for stdout messages +- `on_stderr`: Callback for stderr messages +- `on_result`: Callback for the `Result` object +- `on_error`: Callback for the `ExecutionError` object +- `envs`: Custom environment variables +- `timeout`: Timeout for the code execution in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`Execution` result object + + +### create\_code\_context + +```python Python +def create_code_context(cwd: Optional[str] = None, + language: Optional[str] = None, + request_timeout: Optional[float] = None) -> Context +``` + +Creates a new context to run code in. + +**Arguments**: + +- `cwd`: Set the current working directory for the context, defaults to `/home/user` +- `language`: Language of the context. If not specified, defaults to Python +- `request_timeout`: Timeout for the request in **milliseconds** + +**Returns**: + +Context object + + + + +## OutputMessage + +```python Python +@dataclass +class OutputMessage() +``` + +Represents an output message from the sandbox code execution. + + +### line + +The output line. + + +### timestamp + +Unix epoch in nanoseconds + + +### error + +Whether the output is an error. + + +## ExecutionError + +```python Python +@dataclass +class ExecutionError() +``` + +Represents an error that occurred during the execution of a cell. +The error contains the name of the error, the value of the error, and the traceback. + + +### name + +Name of the error. + + +### value + +Value of the error. + + +### traceback + +The raw traceback of the error. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Error object. + + +## MIMEType + +```python Python +class MIMEType(str) +``` + +Represents a MIME type. + + +## Result + +```python Python +@dataclass +class Result() +``` + +Represents the data to be displayed as a result of executing a cell in a Jupyter notebook. +The result is similar to the structure returned by ipython kernel: https://ipython.readthedocs.io/en/stable/development/execution.html#execution-semantics + +The result can contain multiple types of data, such as text, images, plots, etc. Each type of data is represented +as a string, and the result can contain multiple types of data. The display calls don't have to have text representation, +for the actual result the representation is always present for the result, the other representations are always optional. + + +### is\_main\_result + +Whether this data is the result of the cell. Data can be produced by display calls of which can be multiple in a cell. + + +### extra + +Extra data that can be included. Not part of the standard types. + + +### formats + +```python Python +def formats() -> Iterable[str] +``` + +Returns all available formats of the result. + +**Returns**: + +All available formats of the result in MIME types. + + +### \_\_str\_\_ + +```python Python +def __str__() -> Optional[str] +``` + +Returns the text representation of the data. + +**Returns**: + +The text representation of the data. + + +### \_repr\_html\_ + +```python Python +def _repr_html_() -> Optional[str] +``` + +Returns the HTML representation of the data. + +**Returns**: + +The HTML representation of the data. + + +### \_repr\_markdown\_ + +```python Python +def _repr_markdown_() -> Optional[str] +``` + +Returns the Markdown representation of the data. + +**Returns**: + +The Markdown representation of the data. + + +### \_repr\_svg\_ + +```python Python +def _repr_svg_() -> Optional[str] +``` + +Returns the SVG representation of the data. + +**Returns**: + +The SVG representation of the data. + + +### \_repr\_png\_ + +```python Python +def _repr_png_() -> Optional[str] +``` + +Returns the base64 representation of the PNG data. + +**Returns**: + +The base64 representation of the PNG data. + + +### \_repr\_jpeg\_ + +```python Python +def _repr_jpeg_() -> Optional[str] +``` + +Returns the base64 representation of the JPEG data. + +**Returns**: + +The base64 representation of the JPEG data. + + +### \_repr\_pdf\_ + +```python Python +def _repr_pdf_() -> Optional[str] +``` + +Returns the PDF representation of the data. + +**Returns**: + +The PDF representation of the data. + + +### \_repr\_latex\_ + +```python Python +def _repr_latex_() -> Optional[str] +``` + +Returns the LaTeX representation of the data. + +**Returns**: + +The LaTeX representation of the data. + + +### \_repr\_json\_ + +```python Python +def _repr_json_() -> Optional[dict] +``` + +Returns the JSON representation of the data. + +**Returns**: + +The JSON representation of the data. + + +### \_repr\_javascript\_ + +```python Python +def _repr_javascript_() -> Optional[str] +``` + +Returns the JavaScript representation of the data. + +**Returns**: + +The JavaScript representation of the data. + + +## Logs + +```python Python +@dataclass(repr=False) +class Logs() +``` + +Data printed to stdout and stderr during execution, usually by print statements, logs, warnings, subprocesses, etc. + + +### stdout + +List of strings printed to stdout by prints, subprocesses, etc. + + +### stderr + +List of strings printed to stderr by prints, subprocesses, etc. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Logs object. + + +### serialize\_results + +```python Python +def serialize_results(results: List[Result]) -> List[Dict[str, str]] +``` + +Serializes the results to JSON. + + +## Execution + +```python Python +@dataclass(repr=False) +class Execution() +``` + +Represents the result of a cell execution. + + +### results + +List of the result of the cell (interactively interpreted last line), display calls (e.g. matplotlib plots). + + +### logs + +Logs printed to stdout and stderr during execution. + + +### error + +Error object if an error occurred, None otherwise. + + +### execution\_count + +Execution count of the cell. + + +### text + +```python Python +@property +def text() -> Optional[str] +``` + +Returns the text representation of the result. + +**Returns**: + +The text representation of the result. + + +### to\_json + +```python Python +def to_json() -> str +``` + +Returns the JSON representation of the Execution object. + + +## Context + +```python Python +@dataclass +class Context() +``` + +Represents a context for code execution. + + +### id + +The ID of the context. + + +### language + +The language of the context. + + +### cwd + +The working directory of the context. + + + + + + +## ChartType + +```python Python +class ChartType(str, enum.Enum) +``` + +Chart types + + +## ScaleType + +```python Python +class ScaleType(str, enum.Enum) +``` + +Ax scale types + + +## Chart + +```python Python +class Chart() +``` + +Extracted data from a chart. It's useful for building an interactive charts or custom visualizations. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..b1ef54ed83 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.1/sandbox/index.mdx @@ -0,0 +1,418 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current mouse position. + +###### Returns + +`Promise`\<`object`\> + +An object with `x` and `y` coordinates. + +| Name | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`object`\> + +An object with `width` and `height` properties. + +| Name | Type | +| ------ | ------ | +| `height` | `number` | +| `width` | `number` | + +### getVideoStreamUrl() + +```ts +getVideoStreamUrl(): Promise +``` + +###### Returns + +`Promise`\<`string`\> + +### hotkey() + +```ts +hotkey(...keys: string[]): Promise +``` + +Press a hotkey. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| ...`keys` | `string`[] | The keys to press (e.g. `hotkey("ctrl", "c")` will press Ctrl+C). | + +###### Returns + +`Promise`\<`CommandResult`\> + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`CommandResult`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. +Note that you'll need to wait for the application to be opened. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +### press() + +```ts +press(key: string): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | The key to press (e.g. "enter", "space", "backspace", etc.). | + +###### Returns + +`Promise`\<`CommandResult`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### runPyautoguiCode() + +```ts +runPyautoguiCode(code: string, opts: object): Promise +``` + +Run the given Python code that uses pyautogui. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `code` | `string` | +| `opts` | `object` | +| `opts.onStderr`? | (`data`: `string`) => `void` | +| `opts.onStdout`? | (`data`: `string`) => `void` | + +###### Returns + +`Promise`\<`CommandResult`\> + +### scroll() + +```ts +scroll(amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `amount` | `number` | The amount to scroll. | + +###### Returns + +`Promise`\<`CommandResult`\> + +### takeScreenshot() + +###### takeScreenshot() + +```ts +takeScreenshot(): Promise +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\> + +A Uint8Array bytes representation of the screenshot. + +###### takeScreenshot(format) + +```ts +takeScreenshot(format: "bytes"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +A Uint8Array bytes representation of the screenshot. + +###### takeScreenshot(format) + +```ts +takeScreenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### takeScreenshot(format) + +```ts +takeScreenshot(format: "stream"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +A ReadableStream of bytes representation of the screenshot. + +### write() + +```ts +write(text: string): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | + +###### Returns + +`Promise`\<`CommandResult`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +#### Properties + +### onVideoStreamStart()? + +```ts +optional onVideoStreamStart: (url: string) => void; +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | + +###### Returns + +`void` + +### videoStream? + +```ts +optional videoStream: boolean; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.2/sandbox/index.mdx new file mode 100644 index 0000000000..b1ef54ed83 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.2/sandbox/index.mdx @@ -0,0 +1,418 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current mouse position. + +###### Returns + +`Promise`\<`object`\> + +An object with `x` and `y` coordinates. + +| Name | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`object`\> + +An object with `width` and `height` properties. + +| Name | Type | +| ------ | ------ | +| `height` | `number` | +| `width` | `number` | + +### getVideoStreamUrl() + +```ts +getVideoStreamUrl(): Promise +``` + +###### Returns + +`Promise`\<`string`\> + +### hotkey() + +```ts +hotkey(...keys: string[]): Promise +``` + +Press a hotkey. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| ...`keys` | `string`[] | The keys to press (e.g. `hotkey("ctrl", "c")` will press Ctrl+C). | + +###### Returns + +`Promise`\<`CommandResult`\> + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`CommandResult`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. +Note that you'll need to wait for the application to be opened. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +### press() + +```ts +press(key: string): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | The key to press (e.g. "enter", "space", "backspace", etc.). | + +###### Returns + +`Promise`\<`CommandResult`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`CommandResult`\> + +### runPyautoguiCode() + +```ts +runPyautoguiCode(code: string, opts: object): Promise +``` + +Run the given Python code that uses pyautogui. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `code` | `string` | +| `opts` | `object` | +| `opts.onStderr`? | (`data`: `string`) => `void` | +| `opts.onStdout`? | (`data`: `string`) => `void` | + +###### Returns + +`Promise`\<`CommandResult`\> + +### scroll() + +```ts +scroll(amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `amount` | `number` | The amount to scroll. | + +###### Returns + +`Promise`\<`CommandResult`\> + +### takeScreenshot() + +###### takeScreenshot() + +```ts +takeScreenshot(): Promise +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\> + +A Uint8Array bytes representation of the screenshot. + +###### takeScreenshot(format) + +```ts +takeScreenshot(format: "bytes"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +A Uint8Array bytes representation of the screenshot. + +###### takeScreenshot(format) + +```ts +takeScreenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### takeScreenshot(format) + +```ts +takeScreenshot(format: "stream"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +A ReadableStream of bytes representation of the screenshot. + +### write() + +```ts +write(text: string): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | + +###### Returns + +`Promise`\<`CommandResult`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +#### Properties + +### onVideoStreamStart()? + +```ts +optional onVideoStreamStart: (url: string) => void; +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `url` | `string` | + +###### Returns + +`void` + +### videoStream? + +```ts +optional videoStream: boolean; +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.3/sandbox/index.mdx new file mode 100644 index 0000000000..39ee0fea71 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.0.3/sandbox/index.mdx @@ -0,0 +1,437 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`null` \| `CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`null` \| `ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | The key to press (e.g. "enter", "space", "backspace", etc.). | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### Call Signature + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "up" | "down", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"up"` \| `"down"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | \{ `chunkSize`: `number`; `delayInMs`: `number`; \} | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### Call Signature + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +``` + +###### Call Signature + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +``` + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### enableAuth? + +```ts +optional enableAuth: boolean; +``` + +Whether to enable authentication for noVNC connections. + +### port? + +```ts +optional port: number; +``` + +Port number for the noVNC proxy server. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. + +### vncPort? + +```ts +optional vncPort: number; +``` + +Port number for the VNC server. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.1.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.1.1/sandbox/index.mdx new file mode 100644 index 0000000000..39ee0fea71 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.1.1/sandbox/index.mdx @@ -0,0 +1,437 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`null` \| `CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`null` \| `ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | The key to press (e.g. "enter", "space", "backspace", etc.). | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### Call Signature + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "up" | "down", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"up"` \| `"down"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | \{ `chunkSize`: `number`; `delayInMs`: `number`; \} | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### Call Signature + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +``` + +###### Call Signature + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +``` + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### enableAuth? + +```ts +optional enableAuth: boolean; +``` + +Whether to enable authentication for noVNC connections. + +### port? + +```ts +optional port: number; +``` + +Port number for the noVNC proxy server. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. + +### vncPort? + +```ts +optional vncPort: number; +``` + +Port number for the VNC server. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.2.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.2.0/sandbox/index.mdx new file mode 100644 index 0000000000..4d976ab1fa --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.2.0/sandbox/index.mdx @@ -0,0 +1,437 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | The key to press (e.g. "enter", "space", "backspace", etc.). | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### Call Signature + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "up" | "down", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"up"` \| `"down"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | \{ `chunkSize`: `number`; `delayInMs`: `number`; \} | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### Call Signature + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +``` + +###### Call Signature + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +``` + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### enableAuth? + +```ts +optional enableAuth: boolean; +``` + +Whether to enable authentication for noVNC connections. + +### port? + +```ts +optional port: number; +``` + +Port number for the noVNC proxy server. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. + +### vncPort? + +```ts +optional vncPort: number; +``` + +Port number for the VNC server. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.3.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.3.0/sandbox/index.mdx new file mode 100644 index 0000000000..0a542abb3f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.3.0/sandbox/index.mdx @@ -0,0 +1,413 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` | The key to press (e.g. "enter", "space", "backspace", etc.). | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### Call Signature + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### Call Signature + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "up" | "down", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"up"` \| `"down"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | \{ `chunkSize`: `number`; `delayInMs`: `number`; \} | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### Call Signature + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +``` + +###### Call Signature + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +``` + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.4.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.4.0/sandbox/index.mdx new file mode 100644 index 0000000000..baff718b34 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.4.0/sandbox/index.mdx @@ -0,0 +1,446 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "up" | "down", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"up"` \| `"down"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.5.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.5.0/sandbox/index.mdx new file mode 100644 index 0000000000..443f1e8360 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.5.0/sandbox/index.mdx @@ -0,0 +1,482 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "up" | "down", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"up"` \| `"down"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.0/sandbox/index.mdx new file mode 100644 index 0000000000..443f1e8360 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.0/sandbox/index.mdx @@ -0,0 +1,482 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "up" | "down", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"up"` \| `"down"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.1/sandbox/index.mdx new file mode 100644 index 0000000000..1670b16f2f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.1/sandbox/index.mdx @@ -0,0 +1,482 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(): Promise +``` + +Double left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(): Promise +``` + +Left click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(): Promise +``` + +Middle click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(): Promise +``` + +Right click on the current mouse position. + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.2/sandbox/index.mdx new file mode 100644 index 0000000000..ae727e3a0a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.6.2/sandbox/index.mdx @@ -0,0 +1,510 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.0/sandbox/index.mdx new file mode 100644 index 0000000000..ae727e3a0a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.0/sandbox/index.mdx @@ -0,0 +1,510 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.1/sandbox/index.mdx new file mode 100644 index 0000000000..ae727e3a0a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.1/sandbox/index.mdx @@ -0,0 +1,510 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.2/sandbox/index.mdx new file mode 100644 index 0000000000..6a22ae391f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.2/sandbox/index.mdx @@ -0,0 +1,564 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.3/sandbox/index.mdx new file mode 100644 index 0000000000..6a22ae391f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.7.3/sandbox/index.mdx @@ -0,0 +1,564 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.0/sandbox/index.mdx new file mode 100644 index 0000000000..6a22ae391f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.0/sandbox/index.mdx @@ -0,0 +1,564 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | +| ------ | ------ | ------ | +| `display` | `readonly` | `string` | +| `stream` | `readonly` | `VNCServer` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.1/sandbox/index.mdx new file mode 100644 index 0000000000..903a295cfb --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.8.1/sandbox/index.mdx @@ -0,0 +1,564 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | Default value | +| ------ | ------ | ------ | ------ | +| `display` | `public` | `string` | `':0'` | +| `stream` | `public` | `VNCServer` | `undefined` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.0/sandbox/index.mdx new file mode 100644 index 0000000000..2373e30e4a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.0/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | Default value | +| ------ | ------ | ------ | ------ | +| `display` | `public` | `string` | `':0'` | +| `stream` | `public` | `VNCServer` | `undefined` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### launch() + +```ts +launch(application: string, uri?: string): Promise +``` + +Launch an application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `application` | `string` | The application to launch. | +| `uri`? | `string` | The URI to open in the application. | + +###### Returns + +`Promise`\<`void`\> + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.1/sandbox/index.mdx new file mode 100644 index 0000000000..2373e30e4a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.1/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | Default value | +| ------ | ------ | ------ | ------ | +| `display` | `public` | `string` | `':0'` | +| `stream` | `public` | `VNCServer` | `undefined` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### launch() + +```ts +launch(application: string, uri?: string): Promise +``` + +Launch an application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `application` | `string` | The application to launch. | +| `uri`? | `string` | The URI to open in the application. | + +###### Returns + +`Promise`\<`void`\> + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.2/sandbox/index.mdx new file mode 100644 index 0000000000..2373e30e4a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v1.9.2/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | Default value | +| ------ | ------ | ------ | ------ | +| `display` | `public` | `string` | `':0'` | +| `stream` | `public` | `VNCServer` | `undefined` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### launch() + +```ts +launch(application: string, uri?: string): Promise +``` + +Launch an application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `application` | `string` | The application to launch. | +| `uri`? | `string` | The URI to open in the application. | + +###### Returns + +`Promise`\<`void`\> + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..71ba9f0fa5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.0/sandbox/index.mdx @@ -0,0 +1,696 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | Default value | +| ------ | ------ | ------ | ------ | +| `display` | `public` | `string` | `':0'` | +| `stream` | `public` | `VNCServer` | `undefined` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### launch() + +```ts +launch(application: string, uri?: string): Promise +``` + +Launch an application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `application` | `string` | The application to launch. | +| `uri`? | `string` | The URI to open in the application. | + +###### Returns + +`Promise`\<`void`\> + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxBetaCreateOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. + +*** + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..71ba9f0fa5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-js-sdk/v2.0.1/sandbox/index.mdx @@ -0,0 +1,696 @@ +--- +title: Sandbox +--- + +### Sandbox + +#### Properties + +| Property | Modifier | Type | Default value | +| ------ | ------ | ------ | ------ | +| `display` | `public` | `string` | `':0'` | +| `stream` | `public` | `VNCServer` | `undefined` | + +#### Methods + +### doubleClick() + +```ts +doubleClick(x?: number, y?: number): Promise +``` + +Double left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### drag() + +```ts +drag(from: [number, number], to: [number, number]): Promise +``` + +Drag the mouse from the given position to the given position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `from` | [`number`, `number`] | The starting position. | +| `to` | [`number`, `number`] | The ending position. | + +###### Returns + +`Promise`\<`void`\> + +### getApplicationWindows() + +```ts +getApplicationWindows(application: string): Promise +``` + +Get the window ID of the window with the given title. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `application` | `string` | + +###### Returns + +`Promise`\<`string`[]\> + +The ID of the window. + +### getCurrentWindowId() + +```ts +getCurrentWindowId(): Promise +``` + +Get the current window ID. + +###### Returns + +`Promise`\<`string`\> + +The ID of the current window. + +### getCursorPosition() + +```ts +getCursorPosition(): Promise +``` + +Get the current cursor position. + +###### Returns + +`Promise`\<`CursorPosition`\> + +A object with the x and y coordinates + +###### Throws + +Error if cursor position cannot be determined + +### getScreenSize() + +```ts +getScreenSize(): Promise +``` + +Get the current screen size. + +###### Returns + +`Promise`\<`ScreenSize`\> + +An ScreenSize object + +###### Throws + +Error if screen size cannot be determined + +### getWindowTitle() + +```ts +getWindowTitle(windowId: string): Promise +``` + +Get the title of the window with the given ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `windowId` | `string` | The ID of the window. | + +###### Returns + +`Promise`\<`string`\> + +The title of the window. + +### launch() + +```ts +launch(application: string, uri?: string): Promise +``` + +Launch an application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `application` | `string` | The application to launch. | +| `uri`? | `string` | The URI to open in the application. | + +###### Returns + +`Promise`\<`void`\> + +### leftClick() + +```ts +leftClick(x?: number, y?: number): Promise +``` + +Left click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### middleClick() + +```ts +middleClick(x?: number, y?: number): Promise +``` + +Middle click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### mousePress() + +```ts +mousePress(button: "left" | "right" | "middle"): Promise +``` + +Press the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### mouseRelease() + +```ts +mouseRelease(button: "left" | "right" | "middle"): Promise +``` + +Release the mouse button. + +###### Parameters + +| Parameter | Type | Default value | +| ------ | ------ | ------ | +| `button` | `"left"` \| `"right"` \| `"middle"` | `'left'` | + +###### Returns + +`Promise`\<`void`\> + +### moveMouse() + +```ts +moveMouse(x: number, y: number): Promise +``` + +Move the mouse to the given coordinates. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `x` | `number` | The x coordinate. | +| `y` | `number` | The y coordinate. | + +###### Returns + +`Promise`\<`void`\> + +### open() + +```ts +open(fileOrUrl: string): Promise +``` + +Open a file or a URL in the default application. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `fileOrUrl` | `string` | The file or URL to open. | + +###### Returns + +`Promise`\<`void`\> + +### press() + +```ts +press(key: string | string[]): Promise +``` + +Press a key. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `key` | `string` \| `string`[] | The key to press (e.g. "enter", "space", "backspace", etc.). Can be a single key or an array of keys. | + +###### Returns + +`Promise`\<`void`\> + +### rightClick() + +```ts +rightClick(x?: number, y?: number): Promise +``` + +Right click on the mouse position. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x`? | `number` | +| `y`? | `number` | + +###### Returns + +`Promise`\<`void`\> + +### screenshot() + +###### screenshot() + +```ts +screenshot(): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "bytes"): Promise> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `format` | `"bytes"` | The format of the screenshot. | + +###### Returns + +`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> + +A Uint8Array bytes representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "blob"): Promise +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"blob"` | + +###### Returns + +`Promise`\<`Blob`\> + +A Blob representation of the screenshot. + +###### screenshot(format) + +```ts +screenshot(format: "stream"): Promise>> +``` + +Take a screenshot and save it to the given name. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `format` | `"stream"` | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>\> + +A ReadableStream of bytes representation of the screenshot. + +### scroll() + +```ts +scroll(direction: "down" | "up", amount: number): Promise +``` + +Scroll the mouse wheel by the given amount. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `direction` | `"down"` \| `"up"` | `'down'` | The direction to scroll. Can be "up" or "down". | +| `amount` | `number` | `1` | The amount to scroll. | + +###### Returns + +`Promise`\<`void`\> + +### wait() + +```ts +wait(ms: number): Promise +``` + +Wait for the given amount of time. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `ms` | `number` | The amount of time to wait in milliseconds. | + +###### Returns + +`Promise`\<`void`\> + +### waitAndVerify() + +```ts +waitAndVerify( + cmd: string, + onResult: (result: CommandResult) => boolean, + timeout: number, +interval: number): Promise +``` + +Wait for a command to return a specific result. + +###### Parameters + +| Parameter | Type | Default value | Description | +| ------ | ------ | ------ | ------ | +| `cmd` | `string` | `undefined` | The command to run. | +| `onResult` | (`result`: `CommandResult`) => `boolean` | `undefined` | The function to check the result of the command. | +| `timeout` | `number` | `10` | The maximum time to wait for the command to return the result. | +| `interval` | `number` | `0.5` | The interval to wait between checks. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command returned the result within the timeout, otherwise `false`. + +### write() + +```ts +write(text: string, options: object): Promise +``` + +Write the given text at the current cursor position. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `text` | `string` | The text to write. | +| `options` | `object` | An object containing the chunk size and delay between each chunk of text. | +| `options.chunkSize` | `number` | The size of each chunk of text to write. Default is 25 characters. | +| `options.delayInMs` | `number` | The delay between each chunk of text. Default is 75 ms. | + +###### Returns + +`Promise`\<`void`\> + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `desktop` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +## Interfaces + +### SandboxBetaCreateOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. + +*** + +### SandboxOpts + +Configuration options for the Sandbox environment. + SandboxOpts + +#### Properties + +### display? + +```ts +optional display: string; +``` + +Display identifier. + +### dpi? + +```ts +optional dpi: number; +``` + +Dots per inch (DPI) setting for the display. + +### resolution? + +```ts +optional resolution: [number, number]; +``` + +The screen resolution in pixels, specified as [width, height]. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..ff51d7b863 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.1/sandbox/index.mdx @@ -0,0 +1,202 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### get\_video\_stream\_url + +```python Python +def get_video_stream_url() +``` + +Get the video stream URL. + + +### take\_screenshot + +```python Python +@overload +def take_screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### take\_screenshot + +```python Python +@overload +def take_screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### take\_screenshot + +```python Python +def take_screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(amount: int) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() +``` + +Get the current cursor position. + +**Returns**: + +A tuple with the x and y coordinates. + + +### get\_screen\_size + +```python Python +def get_screen_size() +``` + +Get the current screen size. + +**Returns**: + +A tuple with the width and height. + + +### write + +```python Python +def write(text: str) +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. + + +### press + +```python Python +def press(key: str) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### hotkey + +```python Python +def hotkey(*keys) +``` + +Press a hotkey. + +**Arguments**: + +- `keys`: The keys to press (e.g. `hotkey("ctrl", "c")` will press Ctrl+C). + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.2/sandbox/index.mdx new file mode 100644 index 0000000000..5f62c71f32 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.2/sandbox/index.mdx @@ -0,0 +1,232 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.3/sandbox/index.mdx new file mode 100644 index 0000000000..5f62c71f32 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.0.3/sandbox/index.mdx @@ -0,0 +1,232 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.1.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.1.1/sandbox/index.mdx new file mode 100644 index 0000000000..5f62c71f32 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.1.1/sandbox/index.mdx @@ -0,0 +1,232 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.2.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.2.0/sandbox/index.mdx new file mode 100644 index 0000000000..5f62c71f32 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.2.0/sandbox/index.mdx @@ -0,0 +1,232 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.3.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.3.0/sandbox/index.mdx new file mode 100644 index 0000000000..ed97f6019f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.3.0/sandbox/index.mdx @@ -0,0 +1,259 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.4.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.4.0/sandbox/index.mdx new file mode 100644 index 0000000000..9759864ac8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.4.0/sandbox/index.mdx @@ -0,0 +1,277 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.0/sandbox/index.mdx new file mode 100644 index 0000000000..9759864ac8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.0/sandbox/index.mdx @@ -0,0 +1,277 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.1/sandbox/index.mdx new file mode 100644 index 0000000000..9759864ac8 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.1/sandbox/index.mdx @@ -0,0 +1,277 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click() +``` + +Left click on the current mouse position. + + +### double\_click + +```python Python +def double_click() +``` + +Double left click on the current mouse position. + + +### right\_click + +```python Python +def right_click() +``` + +Right click on the current mouse position. + + +### middle\_click + +```python Python +def middle_click() +``` + +Middle click on the current mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.2/sandbox/index.mdx new file mode 100644 index 0000000000..645b4cae88 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.5.2/sandbox/index.mdx @@ -0,0 +1,268 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.0/sandbox/index.mdx new file mode 100644 index 0000000000..645b4cae88 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.0/sandbox/index.mdx @@ -0,0 +1,268 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.1/sandbox/index.mdx new file mode 100644 index 0000000000..645b4cae88 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.1/sandbox/index.mdx @@ -0,0 +1,268 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.2/sandbox/index.mdx new file mode 100644 index 0000000000..7a05510280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.2/sandbox/index.mdx @@ -0,0 +1,295 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.3/sandbox/index.mdx new file mode 100644 index 0000000000..7a05510280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.3/sandbox/index.mdx @@ -0,0 +1,295 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: str | list[str]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.4/sandbox/index.mdx new file mode 100644 index 0000000000..a12307964b --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.4/sandbox/index.mdx @@ -0,0 +1,295 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.5/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.5/sandbox/index.mdx new file mode 100644 index 0000000000..a12307964b --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.6.5/sandbox/index.mdx @@ -0,0 +1,295 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.0/sandbox/index.mdx new file mode 100644 index 0000000000..3abd981c69 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.0/sandbox/index.mdx @@ -0,0 +1,304 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + + +### launch + +```python Python +def launch(application: str, uri: Optional[str] = None) +``` + +Launch an application. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.1/sandbox/index.mdx new file mode 100644 index 0000000000..3abd981c69 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.1/sandbox/index.mdx @@ -0,0 +1,304 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + + +### launch + +```python Python +def launch(application: str, uri: Optional[str] = None) +``` + +Launch an application. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.2/sandbox/index.mdx new file mode 100644 index 0000000000..0999d909c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.2/sandbox/index.mdx @@ -0,0 +1,306 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the requests made to the returned sandbox + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + + +### launch + +```python Python +def launch(application: str, uri: Optional[str] = None) +``` + +Launch an application. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.3/sandbox/index.mdx new file mode 100644 index 0000000000..0999d909c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.3/sandbox/index.mdx @@ -0,0 +1,306 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the requests made to the returned sandbox + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + + +### launch + +```python Python +def launch(application: str, uri: Optional[str] = None) +``` + +Launch an application. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.4/sandbox/index.mdx new file mode 100644 index 0000000000..0999d909c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v1.7.4/sandbox/index.mdx @@ -0,0 +1,306 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### \_\_init\_\_ + +```python Python +def __init__(resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new desktop sandbox. + +By default, the sandbox is created from the `desktop` template. + +**Arguments**: + +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: If True, the sandbox will be created in debug mode, defaults to `E2B_DEBUG` environment variable +- `sandbox_id`: Sandbox ID to connect to, defaults to `E2B_SANDBOX_ID` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the requests made to the returned sandbox + +**Returns**: + +sandbox instance for the new sandbox + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + + +### launch + +```python Python +def launch(application: str, uri: Optional[str] = None) +``` + +Launch an application. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..39877085d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.0/sandbox/index.mdx @@ -0,0 +1,345 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `desktop` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: Optional[bool] = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `desktop` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + + +### launch + +```python Python +def launch(application: str, uri: Optional[str] = None) +``` + +Launch an application. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..39877085d7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/desktop-python-sdk/v2.0.1/sandbox/index.mdx @@ -0,0 +1,345 @@ +--- +title: Sandbox +--- + + + + + + +## Sandbox + +```python Python +class Sandbox(SandboxBase) +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `desktop` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + resolution: Optional[Tuple[int, int]] = None, + dpi: Optional[int] = None, + display: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: Optional[bool] = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `desktop` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `resolution`: Startup the desktop with custom screen resolution. Defaults to (1024, 768) +- `dpi`: Startup the desktop with custom DPI. Defaults to 96 +- `display`: Startup the desktop with custom display. Defaults to ":0" +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["stream"]) -> Iterator[bytes] +``` + +Take a screenshot and return it as a stream of bytes. + + +### screenshot + +```python Python +@overload +def screenshot(format: Literal["bytes"]) -> bytearray +``` + +Take a screenshot and return it as a bytearray. + + +### screenshot + +```python Python +def screenshot(format: Literal["bytes", "stream"] = "bytes") +``` + +Take a screenshot and return it in the specified format. + +**Arguments**: + +- `format`: The format of the screenshot. Can be 'bytes', 'blob', or 'stream'. + +**Returns**: + +The screenshot in the specified format. + + +### left\_click + +```python Python +def left_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Left click on the mouse position. + + +### double\_click + +```python Python +def double_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Double left click on the mouse position. + + +### middle\_click + +```python Python +def middle_click(x: Optional[int] = None, y: Optional[int] = None) +``` + +Middle click on the mouse position. + + +### scroll + +```python Python +def scroll(direction: Literal["up", "down"] = "down", amount: int = 1) +``` + +Scroll the mouse wheel by the given amount. + +**Arguments**: + +- `direction`: The direction to scroll. Can be "up" or "down". +- `amount`: The amount to scroll. + + +### move\_mouse + +```python Python +def move_mouse(x: int, y: int) +``` + +Move the mouse to the given coordinates. + +**Arguments**: + +- `x`: The x coordinate. +- `y`: The y coordinate. + + +### mouse\_press + +```python Python +def mouse_press(button: Literal["left", "right", "middle"] = "left") +``` + +Press the mouse button. + + +### mouse\_release + +```python Python +def mouse_release(button: Literal["left", "right", "middle"] = "left") +``` + +Release the mouse button. + + +### get\_cursor\_position + +```python Python +def get_cursor_position() -> tuple[int, int] +``` + +Get the current cursor position. + +**Raises**: + +- `RuntimeError`: If the cursor position cannot be determined + +**Returns**: + +A tuple with the x and y coordinates + + +### get\_screen\_size + +```python Python +def get_screen_size() -> tuple[int, int] +``` + +Get the current screen size. + +**Raises**: + +- `RuntimeError`: If the screen size cannot be determined + +**Returns**: + +A tuple with the width and height + + +### write + +```python Python +def write(text: str, *, chunk_size: int = 25, delay_in_ms: int = 75) -> None +``` + +Write the given text at the current cursor position. + +**Arguments**: + +- `text`: The text to write. +- `chunk_size`: The size of each chunk of text to write. +- `delay_in_ms`: The delay between each chunk of text. + + +### press + +```python Python +def press(key: Union[str, list[str]]) +``` + +Press a key. + +**Arguments**: + +- `key`: The key to press (e.g. "enter", "space", "backspace", etc.). + + +### drag + +```python Python +def drag(fr: tuple[int, int], to: tuple[int, int]) +``` + +Drag the mouse from the given position to the given position. + +**Arguments**: + +- `from`: The starting position. +- `to`: The ending position. + + +### wait + +```python Python +def wait(ms: int) +``` + +Wait for the given amount of time. + +**Arguments**: + +- `ms`: The amount of time to wait in milliseconds. + + +### open + +```python Python +def open(file_or_url: str) +``` + +Open a file or a URL in the default application. + +**Arguments**: + +- `file_or_url`: The file or URL to open. + + +### get\_current\_window\_id + +```python Python +def get_current_window_id() -> str +``` + +Get the current window ID. + + +### get\_application\_windows + +```python Python +def get_application_windows(application: str) -> list[str] +``` + +Get the window IDs of all windows for the given application. + + +### get\_window\_title + +```python Python +def get_window_title(window_id: str) -> str +``` + +Get the title of the window with the given ID. + + +### launch + +```python Python +def launch(application: str, uri: Optional[str] = None) +``` + +Launch an application. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/index.mdx new file mode 100644 index 0000000000..9697eb718c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/index.mdx @@ -0,0 +1,7 @@ +--- +title: SDK Reference +--- + +This is the SDK reference for the [E2B CLI & Core SDK](https://github.com/e2b-dev/e2b), [Code Interpreter SDK](https://github.com/e2b-dev/code-interpreter), and [Desktop Sandbox SDK](https://github.com/e2b-dev/desktop). + +The reference is intended to be limited to low-level descriptions of various programmatic functionality. If you’re just getting started with E2B, we would instead recommend looking at the [documentation]() first or to get started quickly with an example. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/errors/index.mdx new file mode 100644 index 0000000000..e2085f08de --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/errors/index.mdx @@ -0,0 +1,208 @@ +--- +title: Errors +--- + +## Classes + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +##### new AuthenticationError() + +> **new AuthenticationError**(`message`): `AuthenticationError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`AuthenticationError` + +###### Defined in + +errors.ts:72 + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +##### new InvalidArgumentError() + +> **new InvalidArgumentError**(`message`): `InvalidArgumentError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`InvalidArgumentError` + +###### Defined in + +errors.ts:42 + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +##### new NotEnoughSpaceError() + +> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotEnoughSpaceError` + +###### Defined in + +errors.ts:52 + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +##### new NotFoundError() + +> **new NotFoundError**(`message`): `NotFoundError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotFoundError` + +###### Defined in + +errors.ts:62 + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` + +#### Constructors + +##### new SandboxError() + +> **new SandboxError**(`message`): `SandboxError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`SandboxError` + +###### Defined in + +errors.ts:14 + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +##### new TemplateError() + +> **new TemplateError**(`message`): `TemplateError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TemplateError` + +###### Defined in + +errors.ts:82 + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +##### new TimeoutError() + +> **new TimeoutError**(`message`): `TimeoutError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TimeoutError` + +###### Defined in + +errors.ts:32 + +## Functions + +### formatSandboxTimeoutError() + +> **formatSandboxTimeoutError**(`message`): `TimeoutError` + +#### Parameters + +• **message**: `string` + +#### Returns + +`TimeoutError` + +#### Defined in + +errors.ts:2 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/filesystem/index.mdx new file mode 100644 index 0000000000..88dd2dc55a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/filesystem/index.mdx @@ -0,0 +1,520 @@ +--- +title: Filesystem +--- + +## Enumerations + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +##### DIR + +> **DIR**: `"dir"` + +Filesystem object is a directory. + +###### Defined in + +sandbox/filesystem/index.ts:55 + +##### FILE + +> **FILE**: `"file"` + +Filesystem object is a file. + +###### Defined in + +sandbox/filesystem/index.ts:51 + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +##### new Filesystem() + +> **new Filesystem**(`transport`, `envdApi`, `connectionConfig`): `Filesystem` + +###### Parameters + +• **transport**: `Transport` + +• **envdApi**: `EnvdApiClient` + +• **connectionConfig**: `ConnectionConfig` + +###### Returns + +`Filesystem` + +###### Defined in + +sandbox/filesystem/index.ts:104 + +#### Methods + +##### exists() + +> **exists**(`path`, `opts`?): `Promise`\<`boolean`\> + +Check if a file or a directory exists. + +###### Parameters + +• **path**: `string` + +path to a file or a directory + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +###### Defined in + +sandbox/filesystem/index.ts:399 + +##### list() + +> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\> + +List entries in a directory. + +###### Parameters + +• **path**: `string` + +path to the directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +###### Defined in + +sandbox/filesystem/index.ts:270 + +##### makeDir() + +> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\> + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +• **path**: `string` + +path to a new directory. For example '/dirA/dirB' when creating 'dirB'. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +###### Defined in + +sandbox/filesystem/index.ts:308 + +##### read() + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`string`\> + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### Defined in + +sandbox/filesystem/index.ts:123 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\> + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### Defined in + +sandbox/filesystem/index.ts:138 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Blob`\> + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### Defined in + +sandbox/filesystem/index.ts:153 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +###### Defined in + +sandbox/filesystem/index.ts:168 + +##### remove() + +> **remove**(`path`, `opts`?): `Promise`\<`void`\> + +Remove a file or directory. + +###### Parameters + +• **path**: `string` + +path to a file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:377 + +##### rename() + +> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\> + +Rename a file or directory. + +###### Parameters + +• **oldPath**: `string` + +path to the file or directory to rename. + +• **newPath**: `string` + +new path for the file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +###### Defined in + +sandbox/filesystem/index.ts:339 + +##### watchDir() + +> **watchDir**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\> + +Start watching a directory for filesystem events. + +###### Parameters + +• **path**: `string` + +path to directory to watch. + +• **onEvent** + +callback to call when an event in the directory occurs. + +• **opts?**: `WatchOpts` + +connection options. + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +###### Defined in + +sandbox/filesystem/index.ts:430 + +##### write() + +> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\> + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +• **path**: `string` + +path to file. + +• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> + +data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### Defined in + +sandbox/filesystem/index.ts:224 + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +##### name + +> **name**: `string` + +Name of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:33 + +##### path + +> **path**: `string` + +Path to the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:41 + +##### type? + +> `optional` **type**: `FileType` + +Type of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:37 + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +##### onExit()? + +> `optional` **onExit**: (`err`?) => `void` \| `Promise`\<`void`\> + +Callback to call when the watch operation stops. + +###### Parameters + +• **err?**: `Error` + +###### Returns + +`void` \| `Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:93 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +###### Defined in + +sandbox/filesystem/index.ts:89 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..883aea6d33 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.0/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +## Classes + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +##### commands + +> `readonly` **commands**: `Commands` + +Module for running commands in the sandbox + +###### Defined in + +sandbox/index.ts:74 + +##### files + +> `readonly` **files**: `Filesystem` + +Module for interacting with the sandbox filesystem + +###### Defined in + +sandbox/index.ts:70 + +##### pty + +> `readonly` **pty**: `Pty` + +Module for interacting with the sandbox pseudo-terminals + +###### Defined in + +sandbox/index.ts:78 + +##### sandboxId + +> `readonly` **sandboxId**: `string` + +Unique identifier of the sandbox. + +###### Defined in + +sandbox/index.ts:83 + +#### Methods + +##### downloadUrl() + +> **downloadUrl**(`path`): `string` + +Get the URL to download a file from the sandbox. + +###### Parameters + +• **path**: `string` + +path to the file to download. + +###### Returns + +`string` + +URL for downloading file. + +###### Defined in + +sandbox/index.ts:339 + +##### getHost() + +> **getHost**(`port`): `string` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +• **port**: `number` + +number of the port in the sandbox. + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +`` + +###### Defined in + +sandbox/index.ts:237 + +##### isRunning() + +> **isRunning**(`opts`?): `Promise`\<`boolean`\> + +Check if the sandbox is running. + +###### Parameters + +• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +###### Defined in + +sandbox/index.ts:259 + +##### kill() + +> **kill**(`opts`?): `Promise`\<`void`\> + +Kill the sandbox. + +###### Parameters + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:310 + +##### setTimeout() + +> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:290 + +##### uploadUrl() + +> **uploadUrl**(`path`?): `string` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +• **path?**: `string` + +the directory where to upload the file, defaults to user's home directory. + +###### Returns + +`string` + +URL for uploading file. + +###### Defined in + +sandbox/index.ts:328 + +##### connect() + +> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +###### Defined in + +sandbox/index.ts:209 + +##### create() + +###### create(this, opts) + +> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:143 + +###### create(this, template, opts) + +> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **template**: `string` + +sandbox template name or ID. + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:162 + +##### kill() + +> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\> + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +###### Defined in + +sandbox/sandboxApi.ts:55 + +##### list() + +> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\> + +List all running sandboxes. + +###### Parameters + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +###### Defined in + +sandbox/sandboxApi.ts:90 + +##### setTimeout() + +> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/sandboxApi.ts:129 + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +##### accessToken? + +> `optional` **accessToken**: `string` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +###### Defined in + +connectionConfig.ts:24 + +##### apiKey? + +> `optional` **apiKey**: `string` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +###### Defined in + +connectionConfig.ts:18 + +##### debug? + +> `optional` **debug**: `boolean` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +###### Defined in + +connectionConfig.ts:36 + +##### domain? + +> `optional` **domain**: `string` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +###### Defined in + +connectionConfig.ts:30 + +##### envs? + +> `optional` **envs**: `Record`\<`string`, `string`\> + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:32 + +##### logger? + +> `optional` **logger**: `Logger` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +###### Defined in + +connectionConfig.ts:46 + +##### metadata? + +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:23 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +###### Defined in + +sandbox/index.ts:39 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/errors/index.mdx new file mode 100644 index 0000000000..e2085f08de --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/errors/index.mdx @@ -0,0 +1,208 @@ +--- +title: Errors +--- + +## Classes + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +##### new AuthenticationError() + +> **new AuthenticationError**(`message`): `AuthenticationError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`AuthenticationError` + +###### Defined in + +errors.ts:72 + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +##### new InvalidArgumentError() + +> **new InvalidArgumentError**(`message`): `InvalidArgumentError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`InvalidArgumentError` + +###### Defined in + +errors.ts:42 + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +##### new NotEnoughSpaceError() + +> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotEnoughSpaceError` + +###### Defined in + +errors.ts:52 + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +##### new NotFoundError() + +> **new NotFoundError**(`message`): `NotFoundError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotFoundError` + +###### Defined in + +errors.ts:62 + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` + +#### Constructors + +##### new SandboxError() + +> **new SandboxError**(`message`): `SandboxError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`SandboxError` + +###### Defined in + +errors.ts:14 + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +##### new TemplateError() + +> **new TemplateError**(`message`): `TemplateError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TemplateError` + +###### Defined in + +errors.ts:82 + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +##### new TimeoutError() + +> **new TimeoutError**(`message`): `TimeoutError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TimeoutError` + +###### Defined in + +errors.ts:32 + +## Functions + +### formatSandboxTimeoutError() + +> **formatSandboxTimeoutError**(`message`): `TimeoutError` + +#### Parameters + +• **message**: `string` + +#### Returns + +`TimeoutError` + +#### Defined in + +errors.ts:2 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/filesystem/index.mdx new file mode 100644 index 0000000000..88dd2dc55a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/filesystem/index.mdx @@ -0,0 +1,520 @@ +--- +title: Filesystem +--- + +## Enumerations + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +##### DIR + +> **DIR**: `"dir"` + +Filesystem object is a directory. + +###### Defined in + +sandbox/filesystem/index.ts:55 + +##### FILE + +> **FILE**: `"file"` + +Filesystem object is a file. + +###### Defined in + +sandbox/filesystem/index.ts:51 + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +##### new Filesystem() + +> **new Filesystem**(`transport`, `envdApi`, `connectionConfig`): `Filesystem` + +###### Parameters + +• **transport**: `Transport` + +• **envdApi**: `EnvdApiClient` + +• **connectionConfig**: `ConnectionConfig` + +###### Returns + +`Filesystem` + +###### Defined in + +sandbox/filesystem/index.ts:104 + +#### Methods + +##### exists() + +> **exists**(`path`, `opts`?): `Promise`\<`boolean`\> + +Check if a file or a directory exists. + +###### Parameters + +• **path**: `string` + +path to a file or a directory + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +###### Defined in + +sandbox/filesystem/index.ts:399 + +##### list() + +> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\> + +List entries in a directory. + +###### Parameters + +• **path**: `string` + +path to the directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +###### Defined in + +sandbox/filesystem/index.ts:270 + +##### makeDir() + +> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\> + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +• **path**: `string` + +path to a new directory. For example '/dirA/dirB' when creating 'dirB'. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +###### Defined in + +sandbox/filesystem/index.ts:308 + +##### read() + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`string`\> + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### Defined in + +sandbox/filesystem/index.ts:123 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\> + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### Defined in + +sandbox/filesystem/index.ts:138 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Blob`\> + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### Defined in + +sandbox/filesystem/index.ts:153 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +###### Defined in + +sandbox/filesystem/index.ts:168 + +##### remove() + +> **remove**(`path`, `opts`?): `Promise`\<`void`\> + +Remove a file or directory. + +###### Parameters + +• **path**: `string` + +path to a file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:377 + +##### rename() + +> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\> + +Rename a file or directory. + +###### Parameters + +• **oldPath**: `string` + +path to the file or directory to rename. + +• **newPath**: `string` + +new path for the file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +###### Defined in + +sandbox/filesystem/index.ts:339 + +##### watchDir() + +> **watchDir**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\> + +Start watching a directory for filesystem events. + +###### Parameters + +• **path**: `string` + +path to directory to watch. + +• **onEvent** + +callback to call when an event in the directory occurs. + +• **opts?**: `WatchOpts` + +connection options. + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +###### Defined in + +sandbox/filesystem/index.ts:430 + +##### write() + +> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\> + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +• **path**: `string` + +path to file. + +• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> + +data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### Defined in + +sandbox/filesystem/index.ts:224 + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +##### name + +> **name**: `string` + +Name of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:33 + +##### path + +> **path**: `string` + +Path to the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:41 + +##### type? + +> `optional` **type**: `FileType` + +Type of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:37 + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +##### onExit()? + +> `optional` **onExit**: (`err`?) => `void` \| `Promise`\<`void`\> + +Callback to call when the watch operation stops. + +###### Parameters + +• **err?**: `Error` + +###### Returns + +`void` \| `Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:93 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +###### Defined in + +sandbox/filesystem/index.ts:89 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..883aea6d33 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.1/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +## Classes + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +##### commands + +> `readonly` **commands**: `Commands` + +Module for running commands in the sandbox + +###### Defined in + +sandbox/index.ts:74 + +##### files + +> `readonly` **files**: `Filesystem` + +Module for interacting with the sandbox filesystem + +###### Defined in + +sandbox/index.ts:70 + +##### pty + +> `readonly` **pty**: `Pty` + +Module for interacting with the sandbox pseudo-terminals + +###### Defined in + +sandbox/index.ts:78 + +##### sandboxId + +> `readonly` **sandboxId**: `string` + +Unique identifier of the sandbox. + +###### Defined in + +sandbox/index.ts:83 + +#### Methods + +##### downloadUrl() + +> **downloadUrl**(`path`): `string` + +Get the URL to download a file from the sandbox. + +###### Parameters + +• **path**: `string` + +path to the file to download. + +###### Returns + +`string` + +URL for downloading file. + +###### Defined in + +sandbox/index.ts:339 + +##### getHost() + +> **getHost**(`port`): `string` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +• **port**: `number` + +number of the port in the sandbox. + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +`` + +###### Defined in + +sandbox/index.ts:237 + +##### isRunning() + +> **isRunning**(`opts`?): `Promise`\<`boolean`\> + +Check if the sandbox is running. + +###### Parameters + +• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +###### Defined in + +sandbox/index.ts:259 + +##### kill() + +> **kill**(`opts`?): `Promise`\<`void`\> + +Kill the sandbox. + +###### Parameters + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:310 + +##### setTimeout() + +> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:290 + +##### uploadUrl() + +> **uploadUrl**(`path`?): `string` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +• **path?**: `string` + +the directory where to upload the file, defaults to user's home directory. + +###### Returns + +`string` + +URL for uploading file. + +###### Defined in + +sandbox/index.ts:328 + +##### connect() + +> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +###### Defined in + +sandbox/index.ts:209 + +##### create() + +###### create(this, opts) + +> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:143 + +###### create(this, template, opts) + +> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **template**: `string` + +sandbox template name or ID. + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:162 + +##### kill() + +> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\> + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +###### Defined in + +sandbox/sandboxApi.ts:55 + +##### list() + +> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\> + +List all running sandboxes. + +###### Parameters + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +###### Defined in + +sandbox/sandboxApi.ts:90 + +##### setTimeout() + +> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/sandboxApi.ts:129 + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +##### accessToken? + +> `optional` **accessToken**: `string` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +###### Defined in + +connectionConfig.ts:24 + +##### apiKey? + +> `optional` **apiKey**: `string` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +###### Defined in + +connectionConfig.ts:18 + +##### debug? + +> `optional` **debug**: `boolean` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +###### Defined in + +connectionConfig.ts:36 + +##### domain? + +> `optional` **domain**: `string` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +###### Defined in + +connectionConfig.ts:30 + +##### envs? + +> `optional` **envs**: `Record`\<`string`, `string`\> + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:32 + +##### logger? + +> `optional` **logger**: `Logger` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +###### Defined in + +connectionConfig.ts:46 + +##### metadata? + +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:23 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +###### Defined in + +sandbox/index.ts:39 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/errors/index.mdx new file mode 100644 index 0000000000..e2085f08de --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/errors/index.mdx @@ -0,0 +1,208 @@ +--- +title: Errors +--- + +## Classes + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +##### new AuthenticationError() + +> **new AuthenticationError**(`message`): `AuthenticationError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`AuthenticationError` + +###### Defined in + +errors.ts:72 + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +##### new InvalidArgumentError() + +> **new InvalidArgumentError**(`message`): `InvalidArgumentError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`InvalidArgumentError` + +###### Defined in + +errors.ts:42 + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +##### new NotEnoughSpaceError() + +> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotEnoughSpaceError` + +###### Defined in + +errors.ts:52 + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +##### new NotFoundError() + +> **new NotFoundError**(`message`): `NotFoundError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotFoundError` + +###### Defined in + +errors.ts:62 + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` + +#### Constructors + +##### new SandboxError() + +> **new SandboxError**(`message`): `SandboxError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`SandboxError` + +###### Defined in + +errors.ts:14 + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +##### new TemplateError() + +> **new TemplateError**(`message`): `TemplateError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TemplateError` + +###### Defined in + +errors.ts:82 + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +##### new TimeoutError() + +> **new TimeoutError**(`message`): `TimeoutError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TimeoutError` + +###### Defined in + +errors.ts:32 + +## Functions + +### formatSandboxTimeoutError() + +> **formatSandboxTimeoutError**(`message`): `TimeoutError` + +#### Parameters + +• **message**: `string` + +#### Returns + +`TimeoutError` + +#### Defined in + +errors.ts:2 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/filesystem/index.mdx new file mode 100644 index 0000000000..88dd2dc55a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/filesystem/index.mdx @@ -0,0 +1,520 @@ +--- +title: Filesystem +--- + +## Enumerations + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +##### DIR + +> **DIR**: `"dir"` + +Filesystem object is a directory. + +###### Defined in + +sandbox/filesystem/index.ts:55 + +##### FILE + +> **FILE**: `"file"` + +Filesystem object is a file. + +###### Defined in + +sandbox/filesystem/index.ts:51 + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +##### new Filesystem() + +> **new Filesystem**(`transport`, `envdApi`, `connectionConfig`): `Filesystem` + +###### Parameters + +• **transport**: `Transport` + +• **envdApi**: `EnvdApiClient` + +• **connectionConfig**: `ConnectionConfig` + +###### Returns + +`Filesystem` + +###### Defined in + +sandbox/filesystem/index.ts:104 + +#### Methods + +##### exists() + +> **exists**(`path`, `opts`?): `Promise`\<`boolean`\> + +Check if a file or a directory exists. + +###### Parameters + +• **path**: `string` + +path to a file or a directory + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +###### Defined in + +sandbox/filesystem/index.ts:399 + +##### list() + +> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\> + +List entries in a directory. + +###### Parameters + +• **path**: `string` + +path to the directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +###### Defined in + +sandbox/filesystem/index.ts:270 + +##### makeDir() + +> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\> + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +• **path**: `string` + +path to a new directory. For example '/dirA/dirB' when creating 'dirB'. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +###### Defined in + +sandbox/filesystem/index.ts:308 + +##### read() + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`string`\> + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### Defined in + +sandbox/filesystem/index.ts:123 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\> + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### Defined in + +sandbox/filesystem/index.ts:138 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Blob`\> + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### Defined in + +sandbox/filesystem/index.ts:153 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +###### Defined in + +sandbox/filesystem/index.ts:168 + +##### remove() + +> **remove**(`path`, `opts`?): `Promise`\<`void`\> + +Remove a file or directory. + +###### Parameters + +• **path**: `string` + +path to a file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:377 + +##### rename() + +> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\> + +Rename a file or directory. + +###### Parameters + +• **oldPath**: `string` + +path to the file or directory to rename. + +• **newPath**: `string` + +new path for the file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +###### Defined in + +sandbox/filesystem/index.ts:339 + +##### watchDir() + +> **watchDir**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\> + +Start watching a directory for filesystem events. + +###### Parameters + +• **path**: `string` + +path to directory to watch. + +• **onEvent** + +callback to call when an event in the directory occurs. + +• **opts?**: `WatchOpts` + +connection options. + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +###### Defined in + +sandbox/filesystem/index.ts:430 + +##### write() + +> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\> + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +• **path**: `string` + +path to file. + +• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> + +data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### Defined in + +sandbox/filesystem/index.ts:224 + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +##### name + +> **name**: `string` + +Name of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:33 + +##### path + +> **path**: `string` + +Path to the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:41 + +##### type? + +> `optional` **type**: `FileType` + +Type of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:37 + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +##### onExit()? + +> `optional` **onExit**: (`err`?) => `void` \| `Promise`\<`void`\> + +Callback to call when the watch operation stops. + +###### Parameters + +• **err?**: `Error` + +###### Returns + +`void` \| `Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:93 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +###### Defined in + +sandbox/filesystem/index.ts:89 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/sandbox/index.mdx new file mode 100644 index 0000000000..883aea6d33 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.2/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +## Classes + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +##### commands + +> `readonly` **commands**: `Commands` + +Module for running commands in the sandbox + +###### Defined in + +sandbox/index.ts:74 + +##### files + +> `readonly` **files**: `Filesystem` + +Module for interacting with the sandbox filesystem + +###### Defined in + +sandbox/index.ts:70 + +##### pty + +> `readonly` **pty**: `Pty` + +Module for interacting with the sandbox pseudo-terminals + +###### Defined in + +sandbox/index.ts:78 + +##### sandboxId + +> `readonly` **sandboxId**: `string` + +Unique identifier of the sandbox. + +###### Defined in + +sandbox/index.ts:83 + +#### Methods + +##### downloadUrl() + +> **downloadUrl**(`path`): `string` + +Get the URL to download a file from the sandbox. + +###### Parameters + +• **path**: `string` + +path to the file to download. + +###### Returns + +`string` + +URL for downloading file. + +###### Defined in + +sandbox/index.ts:339 + +##### getHost() + +> **getHost**(`port`): `string` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +• **port**: `number` + +number of the port in the sandbox. + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +`` + +###### Defined in + +sandbox/index.ts:237 + +##### isRunning() + +> **isRunning**(`opts`?): `Promise`\<`boolean`\> + +Check if the sandbox is running. + +###### Parameters + +• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +###### Defined in + +sandbox/index.ts:259 + +##### kill() + +> **kill**(`opts`?): `Promise`\<`void`\> + +Kill the sandbox. + +###### Parameters + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:310 + +##### setTimeout() + +> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:290 + +##### uploadUrl() + +> **uploadUrl**(`path`?): `string` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +• **path?**: `string` + +the directory where to upload the file, defaults to user's home directory. + +###### Returns + +`string` + +URL for uploading file. + +###### Defined in + +sandbox/index.ts:328 + +##### connect() + +> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +###### Defined in + +sandbox/index.ts:209 + +##### create() + +###### create(this, opts) + +> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:143 + +###### create(this, template, opts) + +> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **template**: `string` + +sandbox template name or ID. + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:162 + +##### kill() + +> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\> + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +###### Defined in + +sandbox/sandboxApi.ts:55 + +##### list() + +> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\> + +List all running sandboxes. + +###### Parameters + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +###### Defined in + +sandbox/sandboxApi.ts:90 + +##### setTimeout() + +> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/sandboxApi.ts:129 + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +##### accessToken? + +> `optional` **accessToken**: `string` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +###### Defined in + +connectionConfig.ts:24 + +##### apiKey? + +> `optional` **apiKey**: `string` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +###### Defined in + +connectionConfig.ts:18 + +##### debug? + +> `optional` **debug**: `boolean` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +###### Defined in + +connectionConfig.ts:36 + +##### domain? + +> `optional` **domain**: `string` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +###### Defined in + +connectionConfig.ts:30 + +##### envs? + +> `optional` **envs**: `Record`\<`string`, `string`\> + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:32 + +##### logger? + +> `optional` **logger**: `Logger` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +###### Defined in + +connectionConfig.ts:46 + +##### metadata? + +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:23 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +###### Defined in + +sandbox/index.ts:39 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/errors/index.mdx new file mode 100644 index 0000000000..8ae3f12010 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/errors/index.mdx @@ -0,0 +1,233 @@ +--- +title: Errors +--- + +## Classes + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +##### new AuthenticationError() + +> **new AuthenticationError**(`message`): `AuthenticationError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`AuthenticationError` + +###### Defined in + +errors.ts:72 + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +##### new InvalidArgumentError() + +> **new InvalidArgumentError**(`message`): `InvalidArgumentError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`InvalidArgumentError` + +###### Defined in + +errors.ts:42 + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +##### new NotEnoughSpaceError() + +> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotEnoughSpaceError` + +###### Defined in + +errors.ts:52 + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +##### new NotFoundError() + +> **new NotFoundError**(`message`): `NotFoundError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotFoundError` + +###### Defined in + +errors.ts:62 + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +##### new RateLimitError() + +> **new RateLimitError**(`message`): `RateLimitError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`RateLimitError` + +###### Defined in + +errors.ts:92 + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +##### new SandboxError() + +> **new SandboxError**(`message`): `SandboxError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`SandboxError` + +###### Defined in + +errors.ts:14 + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +##### new TemplateError() + +> **new TemplateError**(`message`): `TemplateError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TemplateError` + +###### Defined in + +errors.ts:82 + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +##### new TimeoutError() + +> **new TimeoutError**(`message`): `TimeoutError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TimeoutError` + +###### Defined in + +errors.ts:32 + +## Functions + +### formatSandboxTimeoutError() + +> **formatSandboxTimeoutError**(`message`): `TimeoutError` + +#### Parameters + +• **message**: `string` + +#### Returns + +`TimeoutError` + +#### Defined in + +errors.ts:2 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/filesystem/index.mdx new file mode 100644 index 0000000000..88dd2dc55a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/filesystem/index.mdx @@ -0,0 +1,520 @@ +--- +title: Filesystem +--- + +## Enumerations + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +##### DIR + +> **DIR**: `"dir"` + +Filesystem object is a directory. + +###### Defined in + +sandbox/filesystem/index.ts:55 + +##### FILE + +> **FILE**: `"file"` + +Filesystem object is a file. + +###### Defined in + +sandbox/filesystem/index.ts:51 + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +##### new Filesystem() + +> **new Filesystem**(`transport`, `envdApi`, `connectionConfig`): `Filesystem` + +###### Parameters + +• **transport**: `Transport` + +• **envdApi**: `EnvdApiClient` + +• **connectionConfig**: `ConnectionConfig` + +###### Returns + +`Filesystem` + +###### Defined in + +sandbox/filesystem/index.ts:104 + +#### Methods + +##### exists() + +> **exists**(`path`, `opts`?): `Promise`\<`boolean`\> + +Check if a file or a directory exists. + +###### Parameters + +• **path**: `string` + +path to a file or a directory + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +###### Defined in + +sandbox/filesystem/index.ts:399 + +##### list() + +> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\> + +List entries in a directory. + +###### Parameters + +• **path**: `string` + +path to the directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +###### Defined in + +sandbox/filesystem/index.ts:270 + +##### makeDir() + +> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\> + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +• **path**: `string` + +path to a new directory. For example '/dirA/dirB' when creating 'dirB'. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +###### Defined in + +sandbox/filesystem/index.ts:308 + +##### read() + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`string`\> + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### Defined in + +sandbox/filesystem/index.ts:123 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\> + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### Defined in + +sandbox/filesystem/index.ts:138 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Blob`\> + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### Defined in + +sandbox/filesystem/index.ts:153 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +###### Defined in + +sandbox/filesystem/index.ts:168 + +##### remove() + +> **remove**(`path`, `opts`?): `Promise`\<`void`\> + +Remove a file or directory. + +###### Parameters + +• **path**: `string` + +path to a file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:377 + +##### rename() + +> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\> + +Rename a file or directory. + +###### Parameters + +• **oldPath**: `string` + +path to the file or directory to rename. + +• **newPath**: `string` + +new path for the file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +###### Defined in + +sandbox/filesystem/index.ts:339 + +##### watchDir() + +> **watchDir**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\> + +Start watching a directory for filesystem events. + +###### Parameters + +• **path**: `string` + +path to directory to watch. + +• **onEvent** + +callback to call when an event in the directory occurs. + +• **opts?**: `WatchOpts` + +connection options. + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +###### Defined in + +sandbox/filesystem/index.ts:430 + +##### write() + +> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\> + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +• **path**: `string` + +path to file. + +• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> + +data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### Defined in + +sandbox/filesystem/index.ts:224 + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +##### name + +> **name**: `string` + +Name of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:33 + +##### path + +> **path**: `string` + +Path to the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:41 + +##### type? + +> `optional` **type**: `FileType` + +Type of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:37 + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +##### onExit()? + +> `optional` **onExit**: (`err`?) => `void` \| `Promise`\<`void`\> + +Callback to call when the watch operation stops. + +###### Parameters + +• **err?**: `Error` + +###### Returns + +`void` \| `Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:93 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +###### Defined in + +sandbox/filesystem/index.ts:89 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/sandbox/index.mdx new file mode 100644 index 0000000000..883aea6d33 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.3/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +## Classes + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +##### commands + +> `readonly` **commands**: `Commands` + +Module for running commands in the sandbox + +###### Defined in + +sandbox/index.ts:74 + +##### files + +> `readonly` **files**: `Filesystem` + +Module for interacting with the sandbox filesystem + +###### Defined in + +sandbox/index.ts:70 + +##### pty + +> `readonly` **pty**: `Pty` + +Module for interacting with the sandbox pseudo-terminals + +###### Defined in + +sandbox/index.ts:78 + +##### sandboxId + +> `readonly` **sandboxId**: `string` + +Unique identifier of the sandbox. + +###### Defined in + +sandbox/index.ts:83 + +#### Methods + +##### downloadUrl() + +> **downloadUrl**(`path`): `string` + +Get the URL to download a file from the sandbox. + +###### Parameters + +• **path**: `string` + +path to the file to download. + +###### Returns + +`string` + +URL for downloading file. + +###### Defined in + +sandbox/index.ts:339 + +##### getHost() + +> **getHost**(`port`): `string` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +• **port**: `number` + +number of the port in the sandbox. + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +`` + +###### Defined in + +sandbox/index.ts:237 + +##### isRunning() + +> **isRunning**(`opts`?): `Promise`\<`boolean`\> + +Check if the sandbox is running. + +###### Parameters + +• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +###### Defined in + +sandbox/index.ts:259 + +##### kill() + +> **kill**(`opts`?): `Promise`\<`void`\> + +Kill the sandbox. + +###### Parameters + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:310 + +##### setTimeout() + +> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:290 + +##### uploadUrl() + +> **uploadUrl**(`path`?): `string` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +• **path?**: `string` + +the directory where to upload the file, defaults to user's home directory. + +###### Returns + +`string` + +URL for uploading file. + +###### Defined in + +sandbox/index.ts:328 + +##### connect() + +> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +###### Defined in + +sandbox/index.ts:209 + +##### create() + +###### create(this, opts) + +> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:143 + +###### create(this, template, opts) + +> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **template**: `string` + +sandbox template name or ID. + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:162 + +##### kill() + +> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\> + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +###### Defined in + +sandbox/sandboxApi.ts:55 + +##### list() + +> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\> + +List all running sandboxes. + +###### Parameters + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +###### Defined in + +sandbox/sandboxApi.ts:90 + +##### setTimeout() + +> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/sandboxApi.ts:129 + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +##### accessToken? + +> `optional` **accessToken**: `string` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +###### Defined in + +connectionConfig.ts:24 + +##### apiKey? + +> `optional` **apiKey**: `string` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +###### Defined in + +connectionConfig.ts:18 + +##### debug? + +> `optional` **debug**: `boolean` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +###### Defined in + +connectionConfig.ts:36 + +##### domain? + +> `optional` **domain**: `string` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +###### Defined in + +connectionConfig.ts:30 + +##### envs? + +> `optional` **envs**: `Record`\<`string`, `string`\> + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:32 + +##### logger? + +> `optional` **logger**: `Logger` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +###### Defined in + +connectionConfig.ts:46 + +##### metadata? + +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:23 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +###### Defined in + +sandbox/index.ts:39 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/errors/index.mdx new file mode 100644 index 0000000000..8ae3f12010 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/errors/index.mdx @@ -0,0 +1,233 @@ +--- +title: Errors +--- + +## Classes + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +##### new AuthenticationError() + +> **new AuthenticationError**(`message`): `AuthenticationError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`AuthenticationError` + +###### Defined in + +errors.ts:72 + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +##### new InvalidArgumentError() + +> **new InvalidArgumentError**(`message`): `InvalidArgumentError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`InvalidArgumentError` + +###### Defined in + +errors.ts:42 + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +##### new NotEnoughSpaceError() + +> **new NotEnoughSpaceError**(`message`): `NotEnoughSpaceError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotEnoughSpaceError` + +###### Defined in + +errors.ts:52 + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +##### new NotFoundError() + +> **new NotFoundError**(`message`): `NotFoundError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`NotFoundError` + +###### Defined in + +errors.ts:62 + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +##### new RateLimitError() + +> **new RateLimitError**(`message`): `RateLimitError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`RateLimitError` + +###### Defined in + +errors.ts:92 + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +##### new SandboxError() + +> **new SandboxError**(`message`): `SandboxError` + +###### Parameters + +• **message**: `any` + +###### Returns + +`SandboxError` + +###### Defined in + +errors.ts:14 + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +##### new TemplateError() + +> **new TemplateError**(`message`): `TemplateError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TemplateError` + +###### Defined in + +errors.ts:82 + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +##### new TimeoutError() + +> **new TimeoutError**(`message`): `TimeoutError` + +###### Parameters + +• **message**: `string` + +###### Returns + +`TimeoutError` + +###### Defined in + +errors.ts:32 + +## Functions + +### formatSandboxTimeoutError() + +> **formatSandboxTimeoutError**(`message`): `TimeoutError` + +#### Parameters + +• **message**: `string` + +#### Returns + +`TimeoutError` + +#### Defined in + +errors.ts:2 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/filesystem/index.mdx new file mode 100644 index 0000000000..729df1311d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/filesystem/index.mdx @@ -0,0 +1,520 @@ +--- +title: Filesystem +--- + +## Enumerations + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +##### DIR + +> **DIR**: `"dir"` + +Filesystem object is a directory. + +###### Defined in + +sandbox/filesystem/index.ts:55 + +##### FILE + +> **FILE**: `"file"` + +Filesystem object is a file. + +###### Defined in + +sandbox/filesystem/index.ts:51 + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +##### new Filesystem() + +> **new Filesystem**(`transport`, `envdApi`, `connectionConfig`): `Filesystem` + +###### Parameters + +• **transport**: `Transport` + +• **envdApi**: `EnvdApiClient` + +• **connectionConfig**: `ConnectionConfig` + +###### Returns + +`Filesystem` + +###### Defined in + +sandbox/filesystem/index.ts:104 + +#### Methods + +##### exists() + +> **exists**(`path`, `opts`?): `Promise`\<`boolean`\> + +Check if a file or a directory exists. + +###### Parameters + +• **path**: `string` + +path to a file or a directory + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +###### Defined in + +sandbox/filesystem/index.ts:402 + +##### list() + +> **list**(`path`, `opts`?): `Promise`\<`EntryInfo`[]\> + +List entries in a directory. + +###### Parameters + +• **path**: `string` + +path to the directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +###### Defined in + +sandbox/filesystem/index.ts:273 + +##### makeDir() + +> **makeDir**(`path`, `opts`?): `Promise`\<`boolean`\> + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +• **path**: `string` + +path to a new directory. For example '/dirA/dirB' when creating 'dirB'. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +###### Defined in + +sandbox/filesystem/index.ts:311 + +##### read() + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`string`\> + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### Defined in + +sandbox/filesystem/index.ts:123 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Uint8Array`\> + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### Defined in + +sandbox/filesystem/index.ts:138 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`Blob`\> + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### Defined in + +sandbox/filesystem/index.ts:153 + +###### read(path, opts) + +> **read**(`path`, `opts`?): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +• **path**: `string` + +path to the file. + +• **opts?**: `FilesystemRequestOpts` & `object` + +connection options. + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +###### Defined in + +sandbox/filesystem/index.ts:168 + +##### remove() + +> **remove**(`path`, `opts`?): `Promise`\<`void`\> + +Remove a file or directory. + +###### Parameters + +• **path**: `string` + +path to a file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:380 + +##### rename() + +> **rename**(`oldPath`, `newPath`, `opts`?): `Promise`\<`EntryInfo`\> + +Rename a file or directory. + +###### Parameters + +• **oldPath**: `string` + +path to the file or directory to rename. + +• **newPath**: `string` + +new path for the file or directory. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +###### Defined in + +sandbox/filesystem/index.ts:342 + +##### watchDir() + +> **watchDir**(`path`, `onEvent`, `opts`?): `Promise`\<`WatchHandle`\> + +Start watching a directory for filesystem events. + +###### Parameters + +• **path**: `string` + +path to directory to watch. + +• **onEvent** + +callback to call when an event in the directory occurs. + +• **opts?**: `WatchOpts` + +connection options. + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +###### Defined in + +sandbox/filesystem/index.ts:433 + +##### write() + +> **write**(`path`, `data`, `opts`?): `Promise`\<`EntryInfo`\> + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +• **path**: `string` + +path to file. + +• **data**: `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> + +data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. + +• **opts?**: `FilesystemRequestOpts` + +connection options. + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### Defined in + +sandbox/filesystem/index.ts:224 + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +##### name + +> **name**: `string` + +Name of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:33 + +##### path + +> **path**: `string` + +Path to the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:41 + +##### type? + +> `optional` **type**: `FileType` + +Type of the filesystem object. + +###### Defined in + +sandbox/filesystem/index.ts:37 + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +##### onExit()? + +> `optional` **onExit**: (`err`?) => `void` \| `Promise`\<`void`\> + +Callback to call when the watch operation stops. + +###### Parameters + +• **err?**: `Error` + +###### Returns + +`void` \| `Promise`\<`void`\> + +###### Defined in + +sandbox/filesystem/index.ts:93 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +###### Defined in + +sandbox/filesystem/index.ts:89 + +##### user? + +> `optional` **user**: `Username` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +###### Defined in + +sandbox/filesystem/index.ts:76 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/sandbox/index.mdx new file mode 100644 index 0000000000..883aea6d33 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.4/sandbox/index.mdx @@ -0,0 +1,583 @@ +--- +title: Sandbox +--- + +## Classes + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +##### commands + +> `readonly` **commands**: `Commands` + +Module for running commands in the sandbox + +###### Defined in + +sandbox/index.ts:74 + +##### files + +> `readonly` **files**: `Filesystem` + +Module for interacting with the sandbox filesystem + +###### Defined in + +sandbox/index.ts:70 + +##### pty + +> `readonly` **pty**: `Pty` + +Module for interacting with the sandbox pseudo-terminals + +###### Defined in + +sandbox/index.ts:78 + +##### sandboxId + +> `readonly` **sandboxId**: `string` + +Unique identifier of the sandbox. + +###### Defined in + +sandbox/index.ts:83 + +#### Methods + +##### downloadUrl() + +> **downloadUrl**(`path`): `string` + +Get the URL to download a file from the sandbox. + +###### Parameters + +• **path**: `string` + +path to the file to download. + +###### Returns + +`string` + +URL for downloading file. + +###### Defined in + +sandbox/index.ts:339 + +##### getHost() + +> **getHost**(`port`): `string` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +• **port**: `number` + +number of the port in the sandbox. + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +`` + +###### Defined in + +sandbox/index.ts:237 + +##### isRunning() + +> **isRunning**(`opts`?): `Promise`\<`boolean`\> + +Check if the sandbox is running. + +###### Parameters + +• **opts?**: `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +###### Defined in + +sandbox/index.ts:259 + +##### kill() + +> **kill**(`opts`?): `Promise`\<`void`\> + +Kill the sandbox. + +###### Parameters + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:310 + +##### setTimeout() + +> **setTimeout**(`timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/index.ts:290 + +##### uploadUrl() + +> **uploadUrl**(`path`?): `string` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +• **path?**: `string` + +the directory where to upload the file, defaults to user's home directory. + +###### Returns + +`string` + +URL for uploading file. + +###### Defined in + +sandbox/index.ts:328 + +##### connect() + +> `static` **connect**\<`S`\>(`this`, `sandboxId`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +###### Defined in + +sandbox/index.ts:209 + +##### create() + +###### create(this, opts) + +> `static` **create**\<`S`\>(`this`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:143 + +###### create(this, template, opts) + +> `static` **create**\<`S`\>(`this`, `template`, `opts`?): `Promise`\<`InstanceType`\<`S`\>\> + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +• **S** *extends* *typeof* `Sandbox` + +###### Parameters + +• **this**: `S` + +• **template**: `string` + +sandbox template name or ID. + +• **opts?**: `SandboxOpts` + +connection options. + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +###### Defined in + +sandbox/index.ts:162 + +##### kill() + +> `static` **kill**(`sandboxId`, `opts`?): `Promise`\<`boolean`\> + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +###### Defined in + +sandbox/sandboxApi.ts:55 + +##### list() + +> `static` **list**(`opts`?): `Promise`\<`SandboxInfo`[]\> + +List all running sandboxes. + +###### Parameters + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +###### Defined in + +sandbox/sandboxApi.ts:90 + +##### setTimeout() + +> `static` **setTimeout**(`sandboxId`, `timeoutMs`, `opts`?): `Promise`\<`void`\> + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +• **sandboxId**: `string` + +sandbox ID. + +• **timeoutMs**: `number` + +timeout in **milliseconds**. + +• **opts?**: `SandboxApiOpts` + +connection options. + +###### Returns + +`Promise`\<`void`\> + +###### Defined in + +sandbox/sandboxApi.ts:129 + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +##### accessToken? + +> `optional` **accessToken**: `string` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +###### Defined in + +connectionConfig.ts:24 + +##### apiKey? + +> `optional` **apiKey**: `string` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +###### Defined in + +connectionConfig.ts:18 + +##### debug? + +> `optional` **debug**: `boolean` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +###### Defined in + +connectionConfig.ts:36 + +##### domain? + +> `optional` **domain**: `string` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +###### Defined in + +connectionConfig.ts:30 + +##### envs? + +> `optional` **envs**: `Record`\<`string`, `string`\> + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:32 + +##### logger? + +> `optional` **logger**: `Logger` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +###### Defined in + +connectionConfig.ts:46 + +##### metadata? + +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +###### Defined in + +sandbox/index.ts:23 + +##### requestTimeoutMs? + +> `optional` **requestTimeoutMs**: `number` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +###### Defined in + +connectionConfig.ts:42 + +##### timeoutMs? + +> `optional` **timeoutMs**: `number` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +###### Defined in + +sandbox/index.ts:39 diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/filesystem/index.mdx new file mode 100644 index 0000000000..6734d3093f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/filesystem/index.mdx @@ -0,0 +1,431 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/sandbox/index.mdx new file mode 100644 index 0000000000..ca0430e90c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.5/sandbox/index.mdx @@ -0,0 +1,502 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxApiOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/filesystem/index.mdx new file mode 100644 index 0000000000..ed5504b828 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/filesystem/index.mdx @@ -0,0 +1,439 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/sandbox/index.mdx new file mode 100644 index 0000000000..ca0430e90c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.6/sandbox/index.mdx @@ -0,0 +1,502 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxApiOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/filesystem/index.mdx new file mode 100644 index 0000000000..ed5504b828 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/filesystem/index.mdx @@ -0,0 +1,439 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/sandbox/index.mdx new file mode 100644 index 0000000000..ca0430e90c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.0.7/sandbox/index.mdx @@ -0,0 +1,502 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxApiOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/sandbox/index.mdx new file mode 100644 index 0000000000..ca0430e90c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.0/sandbox/index.mdx @@ -0,0 +1,502 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxApiOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/sandbox/index.mdx new file mode 100644 index 0000000000..d5eec1582d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.1.1/sandbox/index.mdx @@ -0,0 +1,502 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.dev` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/filesystem/index.mdx new file mode 100644 index 0000000000..b089f700b7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/sandbox/index.mdx new file mode 100644 index 0000000000..56e82a4223 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.10.0/sandbox/index.mdx @@ -0,0 +1,608 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/filesystem/index.mdx new file mode 100644 index 0000000000..b089f700b7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/sandbox/index.mdx new file mode 100644 index 0000000000..36602dc94d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.11.0/sandbox/index.mdx @@ -0,0 +1,649 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: Pick): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxMetricsOpts`, `"start"` \| `"end"` \| `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/filesystem/index.mdx new file mode 100644 index 0000000000..b089f700b7 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/sandbox/index.mdx new file mode 100644 index 0000000000..742b836722 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.12.0/sandbox/index.mdx @@ -0,0 +1,663 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: Pick): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxMetricsOpts`, `"start"` \| `"end"` \| `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### allowInternetAccess? + +```ts +optional allowInternetAccess: boolean; +``` + +Allow sandbox to access the internet + +###### Default + +```ts +true +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/sandbox/index.mdx new file mode 100644 index 0000000000..5f1d13b35a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.0/sandbox/index.mdx @@ -0,0 +1,648 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: Pick): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxMetricsOpts`, `"start"` \| `"end"` \| `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### allowInternetAccess? + +```ts +optional allowInternetAccess: boolean; +``` + +Allow sandbox to access the internet + +###### Default + +```ts +true +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/sandbox/index.mdx new file mode 100644 index 0000000000..5f1d13b35a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.1/sandbox/index.mdx @@ -0,0 +1,648 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: Pick): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxMetricsOpts`, `"start"` \| `"end"` \| `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### allowInternetAccess? + +```ts +optional allowInternetAccess: boolean; +``` + +Allow sandbox to access the internet + +###### Default + +```ts +true +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/sandbox/index.mdx new file mode 100644 index 0000000000..5f1d13b35a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.13.2/sandbox/index.mdx @@ -0,0 +1,648 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: Pick): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxMetricsOpts`, `"start"` \| `"end"` \| `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### allowInternetAccess? + +```ts +optional allowInternetAccess: boolean; +``` + +Allow sandbox to access the internet + +###### Default + +```ts +true +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/sandbox/index.mdx new file mode 100644 index 0000000000..88295fb71d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.0/sandbox/index.mdx @@ -0,0 +1,502 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/sandbox/index.mdx new file mode 100644 index 0000000000..8e82c30c01 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.1/sandbox/index.mdx @@ -0,0 +1,543 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/sandbox/index.mdx new file mode 100644 index 0000000000..89be96b5d9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.2/sandbox/index.mdx @@ -0,0 +1,551 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/sandbox/index.mdx new file mode 100644 index 0000000000..89be96b5d9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.3/sandbox/index.mdx @@ -0,0 +1,551 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/sandbox/index.mdx new file mode 100644 index 0000000000..89be96b5d9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.4/sandbox/index.mdx @@ -0,0 +1,551 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/sandbox/index.mdx new file mode 100644 index 0000000000..89be96b5d9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.2.5/sandbox/index.mdx @@ -0,0 +1,551 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/filesystem/index.mdx new file mode 100644 index 0000000000..6adf4a1c9e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/filesystem/index.mdx @@ -0,0 +1,473 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemRequestOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/sandbox/index.mdx new file mode 100644 index 0000000000..89be96b5d9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.3.0/sandbox/index.mdx @@ -0,0 +1,551 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/sandbox/index.mdx new file mode 100644 index 0000000000..89be96b5d9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.4.0/sandbox/index.mdx @@ -0,0 +1,551 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file to download. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | the directory where to upload the file, defaults to user's home directory. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/commands/index.mdx new file mode 100644 index 0000000000..30f7182120 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/commands/index.mdx @@ -0,0 +1,487 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/sandbox/index.mdx new file mode 100644 index 0000000000..5de844776d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.0/sandbox/index.mdx @@ -0,0 +1,599 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/sandbox/index.mdx new file mode 100644 index 0000000000..5de844776d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.1/sandbox/index.mdx @@ -0,0 +1,599 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/sandbox/index.mdx new file mode 100644 index 0000000000..5de844776d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.2/sandbox/index.mdx @@ -0,0 +1,599 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/sandbox/index.mdx new file mode 100644 index 0000000000..5de844776d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.5.3/sandbox/index.mdx @@ -0,0 +1,599 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/sandbox/index.mdx new file mode 100644 index 0000000000..df9a71aa02 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.6.0/sandbox/index.mdx @@ -0,0 +1,607 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): string +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`string` + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/sandbox/index.mdx new file mode 100644 index 0000000000..5da6ea3158 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.0/sandbox/index.mdx @@ -0,0 +1,607 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/sandbox/index.mdx new file mode 100644 index 0000000000..5da6ea3158 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.7.1/sandbox/index.mdx @@ -0,0 +1,607 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/sandbox/index.mdx new file mode 100644 index 0000000000..5da6ea3158 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.8.0/sandbox/index.mdx @@ -0,0 +1,607 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/sandbox/index.mdx new file mode 100644 index 0000000000..56e82a4223 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.0/sandbox/index.mdx @@ -0,0 +1,608 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/commands/index.mdx new file mode 100644 index 0000000000..2bd2884267 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/filesystem/index.mdx new file mode 100644 index 0000000000..899b6ff113 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/filesystem/index.mdx @@ -0,0 +1,513 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/sandbox/index.mdx new file mode 100644 index 0000000000..56e82a4223 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v1.9.1/sandbox/index.mdx @@ -0,0 +1,608 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: Omit): Promise> +``` + +Connect to an existing sandbox. +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `Omit`\<`SandboxOpts`, `"timeoutMs"` \| `"metadata"` \| `"envs"`\> | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the existing sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): Promise +``` + +List all running sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`Promise`\<`ListedSandbox`[]\> + +list of running sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxOpts + +Options for creating a new Sandbox. + +#### Properties + +### accessToken? + +```ts +optional accessToken: string; +``` + +E2B access token to use for authentication. + +###### Default + +```ts +E2B_ACCESS_TOKEN // environment variable +``` + +### apiKey? + +```ts +optional apiKey: string; +``` + +E2B API key to use for authentication. + +###### Default + +```ts +E2B_API_KEY // environment variable +``` + +### debug? + +```ts +optional debug: boolean; +``` + +**`Internal`** + +If true the SDK starts in the debug mode and connects to the local envd API server. + +###### Default + +E2B_DEBUG // environment variable or `false` + +### domain? + +```ts +optional domain: string; +``` + +Domain to use for the API. + +###### Default + +E2B_DOMAIN // environment variable or `e2b.app` + +### envs? + +```ts +optional envs: Record; +``` + +Custom environment variables for the sandbox. + +Used when executing commands and code in the sandbox. +Can be overridden with the `envs` argument when executing commands or code. + +###### Default + +```ts +{} +``` + +### headers? + +```ts +optional headers: Record; +``` + +Additional headers to send with the request. + +### logger? + +```ts +optional logger: Logger; +``` + +Logger to use for logging messages. It can accept any object that implements `Logger` interface—for example, console. + +### metadata? + +```ts +optional metadata: Record; +``` + +Custom metadata for the sandbox. + +###### Default + +```ts +{} +``` + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +30_000 // 30 seconds +``` + +### secure? + +```ts +optional secure: boolean; +``` + +Secure all traffic coming to the sandbox controller with auth token + +###### Default + +```ts +false +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the sandbox in **milliseconds**. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Default + +```ts +300_000 // 5 minutes +``` + +*** + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignature? + +```ts +optional useSignature: true; +``` + +Use signature for the URL. +This needs to be used in case of using secured envd in sandbox. + +###### Default + +```ts +false +``` + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.0/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.1/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.2/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/errors/index.mdx new file mode 100644 index 0000000000..4d630a8280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/errors/index.mdx @@ -0,0 +1,215 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `AuthenticationError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.0.3/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/errors/index.mdx new file mode 100644 index 0000000000..22c2c21866 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/errors/index.mdx @@ -0,0 +1,214 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.0/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/errors/index.mdx new file mode 100644 index 0000000000..22c2c21866 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/errors/index.mdx @@ -0,0 +1,214 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.1/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/errors/index.mdx new file mode 100644 index 0000000000..22c2c21866 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/errors/index.mdx @@ -0,0 +1,214 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.2/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/errors/index.mdx new file mode 100644 index 0000000000..22c2c21866 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/errors/index.mdx @@ -0,0 +1,214 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: any): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: any): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message: any): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `any` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.3/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/commands/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/commands/index.mdx new file mode 100644 index 0000000000..92606279c5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/commands/index.mdx @@ -0,0 +1,508 @@ +--- +title: Commands +--- + +### Commands + +Module for starting and interacting with commands in the sandbox. + +#### Constructors + +```ts +new Commands(transport: Transport, connectionConfig: ConnectionConfig): Commands +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Commands` + +#### Methods + +### connect() + +```ts +connect(pid: number, opts?: CommandConnectOpts): Promise +``` + +Connect to a running command. +You can use CommandHandle.wait to wait for the command to finish and get execution results. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command to connect to. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +### kill() + +```ts +kill(pid: number, opts?: CommandRequestOpts): Promise +``` + +Kill a running command specified by its process ID. +It uses `SIGKILL` signal to kill the command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the command was killed, `false` if the command was not found. + +### list() + +```ts +list(opts?: CommandRequestOpts): Promise +``` + +List all running commands and PTY sessions. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`ProcessInfo`[]\> + +list of running commands and PTY sessions. + +### run() + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command and wait until it finishes executing. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. | + +###### Returns + +`Promise`\<`CommandResult`\> + +`CommandResult` result of the command execution. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts: CommandStartOpts & object): Promise +``` + +Start a new command in the background. +You can use CommandHandle.wait to wait for the command to finish and get its result. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts` | `CommandStartOpts` & `object` | options for starting the command | + +###### Returns + +`Promise`\<`CommandHandle`\> + +`CommandHandle` handle to interact with the running command. + +###### run(cmd, opts) + +```ts +run(cmd: string, opts?: CommandStartOpts & object): Promise +``` + +Start a new command. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `cmd` | `string` | command to execute. | +| `opts`? | `CommandStartOpts` & `object` | options for starting the command. - `opts.background: true` - runs in background, returns `CommandHandle` - `opts.background: false | undefined` - waits for completion, returns `CommandResult` | + +###### Returns + +`Promise`\<`CommandResult` \| `CommandHandle`\> + +Either a `CommandHandle` or a `CommandResult` (depending on `opts.background`). + +### sendStdin() + +```ts +sendStdin( + pid: number, + data: string, +opts?: CommandRequestOpts): Promise +``` + +Send data to command stdin. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the command. You can get the list of running commands using Commands.list. | +| `data` | `string` | data to send to the command. | +| `opts`? | `CommandRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +*** + +### Pty + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + +#### Constructors + +```ts +new Pty(transport: Transport, connectionConfig: ConnectionConfig): Pty +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Pty` + +#### Methods + +### create() + +```ts +create(opts: PtyCreateOpts): Promise +``` + +Create a new PTY (pseudo-terminal). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts` | `PtyCreateOpts` | options for creating the PTY. | + +###### Returns + +`Promise`\<`CommandHandle`\> + +handle to interact with the PTY. + +### kill() + +```ts +kill(pid: number, opts?: Pick): Promise +``` + +Kill a running PTY specified by process ID. +It uses `SIGKILL` signal to kill the PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the PTY was killed, `false` if the PTY was not found. + +### resize() + +```ts +resize( + pid: number, + size: object, +opts?: Pick): Promise +``` + +Resize PTY. +Call this when the terminal window is resized and the number of columns and rows has changed. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `size` | `object` | new size of the PTY. | +| `size.cols` | `number` | - | +| `size.rows`? | `number` | - | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### sendInput() + +```ts +sendInput( + pid: number, + data: Uint8Array, +opts?: Pick): Promise +``` + +Send input to a PTY. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `pid` | `number` | process ID of the PTY. | +| `data` | `Uint8Array` | input data to send to the PTY. | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### CommandRequestOpts + +Options for sending a command request. + +#### Extended by + +- `CommandStartOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +*** + +### CommandStartOpts + +Options for starting a new command. + +#### Properties + +### background? + +```ts +optional background: boolean; +``` + +If true, starts command in the background and the method returns immediately. +You can use CommandHandle.wait to wait for the command to finish. + +### cwd? + +```ts +optional cwd: string; +``` + +Working directory for the command. + +###### Default + +```ts +// home directory of the user used to start the command +``` + +### envs? + +```ts +optional envs: Record; +``` + +Environment variables used for the command. + +This overrides the default environment variables from `Sandbox` constructor. + +###### Default + +`{}` + +### onStderr()? + +```ts +optional onStderr: (data: string) => void | Promise; +``` + +Callback for command stderr output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### onStdout()? + +```ts +optional onStdout: (data: string) => void | Promise; +``` + +Callback for command stdout output. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `data` | `string` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the command in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to run the command as. + +###### Default + +`user` + +*** + +### ProcessInfo + +Information about a command, PTY session or start command running in the sandbox as process. + +#### Properties + +### args + +```ts +args: string[]; +``` + +Command arguments. + +### cmd + +```ts +cmd: string; +``` + +Command that was executed. + +### cwd? + +```ts +optional cwd: string; +``` + +Executed command working directory. + +### envs + +```ts +envs: Record; +``` + +Environment variables used for the command. + +### pid + +```ts +pid: number; +``` + +Process ID. + +### tag? + +```ts +optional tag: string; +``` + +Custom tag used for identifying special commands like start command in the custom template. + +## Type Aliases + +### CommandConnectOpts + +```ts +type CommandConnectOpts: Pick & CommandRequestOpts; +``` + +Options for connecting to a command. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/errors/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/errors/index.mdx new file mode 100644 index 0000000000..cf7f477485 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/errors/index.mdx @@ -0,0 +1,220 @@ +--- +title: Errors +--- + +### AuthenticationError + +Thrown when authentication fails. + +#### Constructors + +```ts +new AuthenticationError(message: string): AuthenticationError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`AuthenticationError` + +*** + +### InvalidArgumentError + +Thrown when an invalid argument is provided. + +#### Constructors + +```ts +new InvalidArgumentError(message: string, stackTrace?: string): InvalidArgumentError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | +| `stackTrace`? | `string` | + +###### Returns + +`InvalidArgumentError` + +*** + +### NotEnoughSpaceError + +Thrown when there is not enough disk space. + +#### Constructors + +```ts +new NotEnoughSpaceError(message: string, stackTrace?: string): NotEnoughSpaceError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | +| `stackTrace`? | `string` | + +###### Returns + +`NotEnoughSpaceError` + +*** + +### NotFoundError + +Thrown when a resource is not found. + +#### Constructors + +```ts +new NotFoundError(message: string, stackTrace?: string): NotFoundError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | +| `stackTrace`? | `string` | + +###### Returns + +`NotFoundError` + +*** + +### RateLimitError + +Thrown when the API rate limit is exceeded. + +#### Constructors + +```ts +new RateLimitError(message: string): RateLimitError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +###### Returns + +`RateLimitError` + +*** + +### SandboxError + +Base class for all sandbox errors. + +Thrown when general sandbox errors occur. + +#### Extended by + +- `TimeoutError` +- `InvalidArgumentError` +- `NotEnoughSpaceError` +- `NotFoundError` +- `TemplateError` +- `RateLimitError` + +#### Constructors + +```ts +new SandboxError(message?: string, stackTrace?: string): SandboxError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message`? | `string` | +| `stackTrace`? | `string` | + +###### Returns + +`SandboxError` + +*** + +### TemplateError + +Thrown when the template uses old envd version. It isn't compatible with the new SDK. + +#### Constructors + +```ts +new TemplateError(message: string, stackTrace?: string): TemplateError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | +| `stackTrace`? | `string` | + +###### Returns + +`TemplateError` + +*** + +### TimeoutError + +Thrown when a timeout error occurs. + +The [unavailable] error type is caused by sandbox timeout. + +The [canceled] error type is caused by exceeding request timeout. + +The [deadline_exceeded] error type is caused by exceeding the timeout for command execution, watch, etc. + +The [unknown] error type is sometimes caused by the sandbox timeout when the request is not processed correctly. + +#### Constructors + +```ts +new TimeoutError(message: string, stackTrace?: string): TimeoutError +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | +| `stackTrace`? | `string` | + +###### Returns + +`TimeoutError` + +## Functions + +### formatSandboxTimeoutError() + +```ts +function formatSandboxTimeoutError(message: string): TimeoutError +``` + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `message` | `string` | + +#### Returns + +`TimeoutError` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/filesystem/index.mdx new file mode 100644 index 0000000000..0586f2f1f9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/filesystem/index.mdx @@ -0,0 +1,626 @@ +--- +title: Filesystem +--- + +### FileType + +Sandbox filesystem object type. + +#### Enumeration Members + +| Enumeration Member | Value | Description | +| ------ | ------ | ------ | +| `DIR` | `"dir"` | Filesystem object is a directory. | +| `FILE` | `"file"` | Filesystem object is a file. | + +## Classes + +### Filesystem + +Module for interacting with the sandbox filesystem. + +#### Constructors + +```ts +new Filesystem( + transport: Transport, + envdApi: EnvdApiClient, + connectionConfig: ConnectionConfig): Filesystem +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `transport` | `Transport` | +| `envdApi` | `EnvdApiClient` | +| `connectionConfig` | `ConnectionConfig` | + +###### Returns + +`Filesystem` + +#### Methods + +### exists() + +```ts +exists(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Check if a file or a directory exists. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or a directory | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the file or directory exists, `false` otherwise + +### getInfo() + +```ts +getInfo(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Get information about a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about the file or directory like name, type, and path. + +### list() + +```ts +list(path: string, opts?: FilesystemListOpts): Promise +``` + +List entries in a directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the directory. | +| `opts`? | `FilesystemListOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`[]\> + +list of entries in the sandbox filesystem directory. + +### makeDir() + +```ts +makeDir(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Create a new directory and all directories along the way if needed on the specified path. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a new directory. For example '/dirA/dirB' when creating 'dirB'. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the directory was created, `false` if it already exists. + +### read() + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `string`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`string`\> + +file content as string + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Uint8Array`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Uint8Array`\> + +file content as `Uint8Array` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise +``` + +Read file content as a `Blob`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`Blob`\> + +file content as `Blob` + +###### read(path, opts) + +```ts +read(path: string, opts?: FilesystemRequestOpts & object): Promise> +``` + +Read file content as a `ReadableStream`. + +You can pass `text`, `bytes`, `blob`, or `stream` to `opts.format` to change the return type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file. | +| `opts`? | `FilesystemRequestOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`ReadableStream`\<`Uint8Array`\>\> + +file content as `ReadableStream` + +### remove() + +```ts +remove(path: string, opts?: FilesystemRequestOpts): Promise +``` + +Remove a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to a file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### rename() + +```ts +rename( + oldPath: string, + newPath: string, +opts?: FilesystemRequestOpts): Promise +``` + +Rename a file or directory. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `oldPath` | `string` | path to the file or directory to rename. | +| `newPath` | `string` | new path for the file or directory. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`EntryInfo`\> + +information about renamed file or directory. + +### watchDir() + +```ts +watchDir( + path: string, + onEvent: (event: FilesystemEvent) => void | Promise, +opts?: WatchOpts & object): Promise +``` + +Start watching a directory for filesystem events. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to directory to watch. | +| `onEvent` | (`event`: `FilesystemEvent`) => `void` \| `Promise`\<`void`\> | callback to call when an event in the directory occurs. | +| `opts`? | `WatchOpts` & `object` | connection options. | + +###### Returns + +`Promise`\<`WatchHandle`\> + +`WatchHandle` object for stopping watching directory. + +### write() + +###### write(path, data, opts) + +```ts +write( + path: string, + data: string | ArrayBuffer | Blob | ReadableStream, +opts?: FilesystemRequestOpts): Promise +``` + +Write content to a file. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to file. | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream`\<`any`\> | data to write to the file. Data can be a string, `ArrayBuffer`, `Blob`, or `ReadableStream`. | +| `opts`? | `FilesystemRequestOpts` | connection options. | + +###### Returns + +`Promise`\<`WriteInfo`\> + +information about the written file + +###### write(files, opts) + +```ts +write(files: WriteEntry[], opts?: FilesystemRequestOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `files` | `WriteEntry`[] | +| `opts`? | `FilesystemRequestOpts` | + +###### Returns + +`Promise`\<`WriteInfo`[]\> + +## Interfaces + +### EntryInfo + +Sandbox filesystem object information. + +#### Properties + +### group + +```ts +group: string; +``` + +Group owner of the filesystem object. + +### mode + +```ts +mode: number; +``` + +File mode and permission bits. + +### modifiedTime? + +```ts +optional modifiedTime: Date; +``` + +Last modification time of the filesystem object. + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### owner + +```ts +owner: string; +``` + +Owner of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### permissions + +```ts +permissions: string; +``` + +String representation of file permissions (e.g. 'rwxr-xr-x'). + +### size + +```ts +size: number; +``` + +Size of the filesystem object in bytes. + +### symlinkTarget? + +```ts +optional symlinkTarget: string; +``` + +If the filesystem object is a symlink, this is the target of the symlink. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +*** + +### FilesystemListOpts + +Options for the sandbox filesystem operations. + +#### Properties + +### depth? + +```ts +optional depth: number; +``` + +Depth of the directory to list. + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### FilesystemRequestOpts + +Options for the sandbox filesystem operations. + +#### Extended by + +- `FilesystemListOpts` +- `WatchOpts` + +#### Properties + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WatchOpts + +Options for watching a directory. + +#### Properties + +### onExit()? + +```ts +optional onExit: (err?: Error) => void | Promise; +``` + +Callback to call when the watch operation stops. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `err`? | `Error` | + +###### Returns + +`void` \| `Promise`\<`void`\> + +### recursive? + +```ts +optional recursive: boolean; +``` + +Watch the directory recursively + +### requestTimeoutMs? + +```ts +optional requestTimeoutMs: number; +``` + +Timeout for requests to the API in **milliseconds**. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### timeoutMs? + +```ts +optional timeoutMs: number; +``` + +Timeout for the watch operation in **milliseconds**. +You can pass `0` to disable the timeout. + +###### Default + +```ts +60_000 // 60 seconds +``` + +### user? + +```ts +optional user: Username; +``` + +User to use for the operation in the sandbox. +This affects the resolution of relative paths and ownership of the created filesystem objects. + +*** + +### WriteInfo + +Sandbox filesystem object information. + +#### Extended by + +- `EntryInfo` + +#### Properties + +### name + +```ts +name: string; +``` + +Name of the filesystem object. + +### path + +```ts +path: string; +``` + +Path to the filesystem object. + +### type? + +```ts +optional type: FileType; +``` + +Type of the filesystem object. + +## Type Aliases + +### WriteEntry + +```ts +type WriteEntry: object; +``` + +#### Type declaration + +| Name | Type | +| ------ | ------ | +| `data` | `string` \| `ArrayBuffer` \| `Blob` \| `ReadableStream` | +| `path` | `string` | diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/sandbox/index.mdx new file mode 100644 index 0000000000..8bf01fc350 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/js-sdk/v2.1.4/sandbox/index.mdx @@ -0,0 +1,682 @@ +--- +title: Sandbox +--- + +### Sandbox + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs here. + +Use Sandbox.create to create a new sandbox. + +#### Example + +```ts +import { Sandbox } from 'e2b' + +const sandbox = await Sandbox.create() +``` + +#### Properties + +| Property | Modifier | Type | Description | +| ------ | ------ | ------ | ------ | +| `commands` | `readonly` | `Commands` | Module for running commands in the sandbox | +| `files` | `readonly` | `Filesystem` | Module for interacting with the sandbox filesystem | +| `pty` | `readonly` | `Pty` | Module for interacting with the sandbox pseudo-terminals | +| `sandboxDomain` | `readonly` | `string` | Domain where the sandbox is hosted. | +| `sandboxId` | `readonly` | `string` | Unique identifier of the sandbox. | + +#### Methods + +### betaPause() + +```ts +betaPause(opts?: ConnectionOpts): Promise +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Pause a sandbox by its ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `ConnectionOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +sandbox ID that can be used to resume the sandbox. + +### connect() + +```ts +connect(opts?: SandboxBetaCreateOpts): Promise +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`Sandbox`\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.betaPause() + +// Connect to the same sandbox. +const sameSandbox = await sandbox.connect() +``` + +### downloadUrl() + +```ts +downloadUrl(path: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to download a file from the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path` | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for downloading file. + +### getHost() + +```ts +getHost(port: number): string +``` + +Get the host address for the specified sandbox port. +You can then use this address to connect to the sandbox port from outside the sandbox via HTTP or WebSocket. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `port` | `number` | number of the port in the sandbox. | + +###### Returns + +`string` + +host address of the sandbox port. + +###### Example + +```ts +const sandbox = await Sandbox.create() +// Start an HTTP server +await sandbox.commands.exec('python3 -m http.server 3000') +// Get the hostname of the HTTP server +const serverURL = sandbox.getHost(3000) +``` + +### getInfo() + +```ts +getInfo(opts?: Pick): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +information about the sandbox + +### getMetrics() + +```ts +getMetrics(opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxMetricsOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### isRunning() + +```ts +isRunning(opts?: Pick): Promise +``` + +Check if the sandbox is running. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `opts`? | `Pick`\<`ConnectionOpts`, `"requestTimeoutMs"`\> | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox is running, `false` otherwise. + +###### Example + +```ts +const sandbox = await Sandbox.create() +await sandbox.isRunning() // Returns true + +await sandbox.kill() +await sandbox.isRunning() // Returns false +``` + +### kill() + +```ts +kill(opts?: Pick): Promise +``` + +Kill the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### setTimeout() + +```ts +setTimeout(timeoutMs: number, opts?: Pick): Promise +``` + +Set the timeout of the sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.setTimeout`. +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `Pick`\<`SandboxOpts`, `"requestTimeoutMs"`\> | connection options. | + +###### Returns + +`Promise`\<`void`\> + +### uploadUrl() + +```ts +uploadUrl(path?: string, opts?: SandboxUrlOpts): Promise +``` + +Get the URL to upload a file to the sandbox. + +You have to send a POST request to this URL with the file as multipart/form-data. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `path`? | `string` | path to the file in the sandbox. | +| `opts`? | `SandboxUrlOpts` | download url options. | + +###### Returns + +`Promise`\<`string`\> + +URL for uploading file. + +### betaCreate() + +###### betaCreate(this, opts) + +```ts +static betaCreate(this: S, opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate() +``` + +###### Constructs + +Sandbox + +###### betaCreate(this, template, opts) + +```ts +static betaCreate( + this: S, + template: string, +opts?: SandboxBetaCreateOpts): Promise> +``` + +**`Beta`** + +This feature is in beta and may change in the future. + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxBetaCreateOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.betaCreate('') +``` + +###### Constructs + +Sandbox + +### betaPause() + +```ts +static betaPause(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Pause the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox got paused, `false` if the sandbox was already paused. + +### connect() + +```ts +static connect( + this: S, + sandboxId: string, +opts?: SandboxConnectOpts): Promise> +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxConnectOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +A running sandbox instance + +###### Example + +```ts +const sandbox = await Sandbox.create() +const sandboxId = sandbox.sandboxId + +// Connect to the same sandbox. +const sameSandbox = await Sandbox.connect(sandboxId) +``` + +### create() + +###### create(this, opts) + +```ts +static create(this: S, opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the default `base` sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create() +``` + +###### Constructs + +Sandbox + +###### create(this, template, opts) + +```ts +static create( + this: S, + template: string, +opts?: SandboxOpts): Promise> +``` + +Create a new sandbox from the specified sandbox template. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `S` *extends* *typeof* `Sandbox` | + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `this` | `S` | - | +| `template` | `string` | sandbox template name or ID. | +| `opts`? | `SandboxOpts` | connection options. | + +###### Returns + +`Promise`\<`InstanceType`\<`S`\>\> + +sandbox instance for the new sandbox. + +###### Example + +```ts +const sandbox = await Sandbox.create('') +``` + +###### Constructs + +Sandbox + +### getFullInfo() + +```ts +static getFullInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `sandboxId` | `string` | +| `opts`? | `SandboxApiOpts` | + +###### Returns + +`Promise`\<`object`\> + +| Name | Type | Default value | +| ------ | ------ | ------ | +| `cpuCount` | `number` | res.data.cpuCount | +| `endAt` | `Date` | - | +| `envdAccessToken` | `undefined` \| `string` | res.data.envdAccessToken | +| `envdVersion` | `string` | res.data.envdVersion | +| `memoryMB` | `number` | res.data.memoryMB | +| `metadata` | `object` | - | +| `name`? | `string` | res.data.alias | +| `sandboxDomain` | `undefined` \| `string` | - | +| `sandboxId` | `string` | res.data.sandboxID | +| `startedAt` | `Date` | - | +| `state` | `"running"` \| `"paused"` | res.data.state | +| `templateId` | `string` | res.data.templateID | + +### getInfo() + +```ts +static getInfo(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`SandboxInfo`\> + +sandbox information. + +### getMetrics() + +```ts +static getMetrics(sandboxId: string, opts?: SandboxMetricsOpts): Promise +``` + +Get the metrics of the sandbox. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxMetricsOpts` | sandbox metrics options. | + +###### Returns + +`Promise`\<`SandboxMetrics`[]\> + +List of sandbox metrics containing CPU, memory and disk usage information. + +### kill() + +```ts +static kill(sandboxId: string, opts?: SandboxApiOpts): Promise +``` + +Kill the sandbox specified by sandbox ID. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`boolean`\> + +`true` if the sandbox was found and killed, `false` otherwise. + +### list() + +```ts +static list(opts?: SandboxListOpts): SandboxPaginator +``` + +List all sandboxes. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `opts`? | `SandboxListOpts` | connection options. | + +###### Returns + +`SandboxPaginator` + +paginator for listing sandboxes. + +### setTimeout() + +```ts +static setTimeout( + sandboxId: string, + timeoutMs: number, +opts?: SandboxApiOpts): Promise +``` + +Set the timeout of the specified sandbox. +After the timeout expires the sandbox will be automatically killed. + +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to Sandbox.setTimeout. + +Maximum time a sandbox can be kept alive is 24 hours (86_400_000 milliseconds) for Pro users and 1 hour (3_600_000 milliseconds) for Hobby users. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `sandboxId` | `string` | sandbox ID. | +| `timeoutMs` | `number` | timeout in **milliseconds**. | +| `opts`? | `SandboxApiOpts` | connection options. | + +###### Returns + +`Promise`\<`void`\> + +## Interfaces + +### SandboxUrlOpts + +Options for sandbox upload/download URL generation. + +#### Properties + +### user? + +```ts +optional user: Username; +``` + +User that will be used to access the file. + +### useSignatureExpiration? + +```ts +optional useSignatureExpiration: number; +``` + +Use signature expiration for the URL. +Optional parameter to set the expiration time for the signature in seconds. diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/exceptions/index.mdx new file mode 100644 index 0000000000..e0e6ab4c81 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/exceptions/index.mdx @@ -0,0 +1,79 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..a7065fad74 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_async/index.mdx @@ -0,0 +1,928 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +#### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +#### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +#### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +#### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +#### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +#### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +#### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +#### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +#### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +#### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +#### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +#### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +#### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +#### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +#### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +#### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +#### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +#### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +#### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +#### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +#### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +#### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +#### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +#### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +#### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +#### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +#### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +#### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +#### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +#### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +#### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +#### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +#### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +#### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +#### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +#### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +#### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +#### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +#### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +#### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..72fa0c3a66 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.0/sandbox_sync/index.mdx @@ -0,0 +1,905 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +#### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +#### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +#### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +#### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +#### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +#### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +#### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +#### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) + + +#### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +#### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +#### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +#### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +#### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +#### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +#### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +#### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +#### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +#### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +#### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +#### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +#### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +#### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +#### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +#### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +#### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +#### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +#### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +#### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +#### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +#### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +#### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +#### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +#### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +#### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/exceptions/index.mdx new file mode 100644 index 0000000000..e0e6ab4c81 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/exceptions/index.mdx @@ -0,0 +1,79 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..10f756e7c2 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_async/index.mdx @@ -0,0 +1,928 @@ +--- +title: Sandbox Async +--- + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +#### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +#### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +#### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +#### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +#### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +#### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +#### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +#### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +#### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +#### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +#### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +#### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +#### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +#### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +#### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +#### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +#### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +#### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +#### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +#### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +#### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +#### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +#### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +#### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +#### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +#### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +#### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +#### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +#### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +#### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +#### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +#### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +#### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +#### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +#### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +#### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +#### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +#### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +#### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +#### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..b421c18108 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.1/sandbox_sync/index.mdx @@ -0,0 +1,905 @@ +--- +title: Sandbox Sync +--- + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +#### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +#### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +#### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +#### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +#### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +#### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +#### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +#### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +#### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +#### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +#### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +#### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +#### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +#### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +#### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +#### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +#### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +#### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +#### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +#### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +#### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +#### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +#### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) + + +#### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +#### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +#### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +#### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +#### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +#### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +#### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +#### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +#### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +#### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +#### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/exceptions/index.mdx new file mode 100644 index 0000000000..b5d3bc754e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_async/index.mdx new file mode 100644 index 0000000000..10f756e7c2 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_async/index.mdx @@ -0,0 +1,928 @@ +--- +title: Sandbox Async +--- + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +#### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +#### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +#### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +#### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +#### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +#### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +#### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +#### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +#### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +#### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +#### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +#### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +#### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +#### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +#### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +#### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +#### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +#### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +#### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +#### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +#### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +#### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +#### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +#### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +#### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +#### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +#### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +#### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +#### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +#### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +#### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +#### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +#### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +#### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +#### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +#### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +#### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +#### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +#### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +#### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_sync/index.mdx new file mode 100644 index 0000000000..b421c18108 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.2/sandbox_sync/index.mdx @@ -0,0 +1,905 @@ +--- +title: Sandbox Sync +--- + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +#### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +#### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +#### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +#### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +#### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +#### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +#### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +#### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +#### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +#### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +#### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +#### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +#### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +#### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +#### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +#### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +#### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +#### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +#### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +#### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +#### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +#### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +#### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) + + +#### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +#### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +#### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +#### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +#### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +#### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +#### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +#### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +#### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +#### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +#### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +#### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +#### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/exceptions/index.mdx new file mode 100644 index 0000000000..b5d3bc754e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_async/index.mdx new file mode 100644 index 0000000000..356a88d280 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_async/index.mdx @@ -0,0 +1,928 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_sync/index.mdx new file mode 100644 index 0000000000..8568d95dda --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.3/sandbox_sync/index.mdx @@ -0,0 +1,905 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/exceptions/index.mdx new file mode 100644 index 0000000000..b5d3bc754e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_async/index.mdx new file mode 100644 index 0000000000..cd126dcca2 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_async/index.mdx @@ -0,0 +1,928 @@ +--- +title: Sandbox Async +--- + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_sync/index.mdx new file mode 100644 index 0000000000..c00adba277 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.4/sandbox_sync/index.mdx @@ -0,0 +1,905 @@ +--- +title: Sandbox Sync +--- + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/exceptions/index.mdx new file mode 100644 index 0000000000..b5d3bc754e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_async/index.mdx new file mode 100644 index 0000000000..cd126dcca2 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_async/index.mdx @@ -0,0 +1,928 @@ +--- +title: Sandbox Async +--- + + + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_sync/index.mdx new file mode 100644 index 0000000000..c00adba277 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.5/sandbox_sync/index.mdx @@ -0,0 +1,905 @@ +--- +title: Sandbox Sync +--- + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/exceptions/index.mdx new file mode 100644 index 0000000000..b5d3bc754e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_async/index.mdx new file mode 100644 index 0000000000..983c056f9c --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_async/index.mdx @@ -0,0 +1,930 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_sync/index.mdx new file mode 100644 index 0000000000..09aaeaa622 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.0.6/sandbox_sync/index.mdx @@ -0,0 +1,908 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/exceptions/index.mdx new file mode 100644 index 0000000000..b5d3bc754e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The [unavailable] exception type is caused by sandbox timeout. + +The [canceled] exception type is caused by exceeding request timeout. + +The [deadline_exceeded] exception type is caused by exceeding the timeout for process, watch, etc. + +The [unknown] exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..f2aa5c3b9b --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_async/index.mdx @@ -0,0 +1,930 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..6331f9d7a4 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.1.0/sandbox_sync/index.mdx @@ -0,0 +1,908 @@ +--- +title: Sandbox Sync +--- + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..d750de79dd --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_async/index.mdx @@ -0,0 +1,1166 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[WriteInfo, List[WriteInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None, + allow_internet_access: Optional[bool] = True) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..84f759f2e5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.10.0/sandbox_sync/index.mdx @@ -0,0 +1,1130 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Domain where the sandbox is hosted. + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + allow_internet_access: Optional[bool] = True) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True` + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..d750de79dd --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_async/index.mdx @@ -0,0 +1,1166 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[WriteInfo, List[WriteInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None, + allow_internet_access: Optional[bool] = True) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..84f759f2e5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.0/sandbox_sync/index.mdx @@ -0,0 +1,1130 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Domain where the sandbox is hosted. + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + allow_internet_access: Optional[bool] = True) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True` + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..d750de79dd --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_async/index.mdx @@ -0,0 +1,1166 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[WriteInfo, List[WriteInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None, + allow_internet_access: Optional[bool] = True) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..84f759f2e5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.11.1/sandbox_sync/index.mdx @@ -0,0 +1,1130 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Domain where the sandbox is hosted. + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + allow_internet_access: Optional[bool] = True) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True` + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..6fd2717e3a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_async/index.mdx @@ -0,0 +1,970 @@ +--- +title: Sandbox Async +--- + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..346828958a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.0/sandbox_sync/index.mdx @@ -0,0 +1,935 @@ +--- +title: Sandbox Sync +--- + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..b08d565571 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_async/index.mdx @@ -0,0 +1,974 @@ +--- +title: Sandbox Async +--- + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..1453d2a6b1 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.2.1/sandbox_sync/index.mdx @@ -0,0 +1,939 @@ +--- +title: Sandbox Sync +--- + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..b08d565571 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_async/index.mdx @@ -0,0 +1,974 @@ +--- +title: Sandbox Async +--- + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..1453d2a6b1 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.0/sandbox_sync/index.mdx @@ -0,0 +1,939 @@ +--- +title: Sandbox Sync +--- + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..f0ae20f7b3 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_async/index.mdx @@ -0,0 +1,1018 @@ +--- +title: Sandbox Async +--- + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox id, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..17dc87035e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.1/sandbox_sync/index.mdx @@ -0,0 +1,983 @@ +--- +title: Sandbox Sync +--- + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox id, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_async/index.mdx new file mode 100644 index 0000000000..bc053c7f82 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_async/index.mdx @@ -0,0 +1,1018 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_sync/index.mdx new file mode 100644 index 0000000000..1a6f21c83a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.2/sandbox_sync/index.mdx @@ -0,0 +1,983 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_async/index.mdx new file mode 100644 index 0000000000..b55f963323 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_async/index.mdx @@ -0,0 +1,1022 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_sync/index.mdx new file mode 100644 index 0000000000..4fe42aee4e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.3/sandbox_sync/index.mdx @@ -0,0 +1,987 @@ +--- +title: Sandbox Sync +--- + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_async/index.mdx new file mode 100644 index 0000000000..b55f963323 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_async/index.mdx @@ -0,0 +1,1022 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_sync/index.mdx new file mode 100644 index 0000000000..4fe42aee4e --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.4/sandbox_sync/index.mdx @@ -0,0 +1,987 @@ +--- +title: Sandbox Sync +--- + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_async/index.mdx new file mode 100644 index 0000000000..5ea4e635c9 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_async/index.mdx @@ -0,0 +1,1034 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_sync/index.mdx new file mode 100644 index 0000000000..5cf297379d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.3.5/sandbox_sync/index.mdx @@ -0,0 +1,998 @@ +--- +title: Sandbox Sync +--- + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..925e96e626 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_async/index.mdx @@ -0,0 +1,1036 @@ +--- +title: Sandbox Async +--- + + + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..55718907ad --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.4.0/sandbox_sync/index.mdx @@ -0,0 +1,1000 @@ +--- +title: Sandbox Sync +--- + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[SandboxInfo] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..a075e1f15a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_async/index.mdx @@ -0,0 +1,1038 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..f628a5eb5a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.0/sandbox_sync/index.mdx @@ -0,0 +1,1001 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..a075e1f15a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_async/index.mdx @@ -0,0 +1,1038 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..f628a5eb5a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.1/sandbox_sync/index.mdx @@ -0,0 +1,1001 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_async/index.mdx new file mode 100644 index 0000000000..ed86274b64 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_async/index.mdx @@ -0,0 +1,1038 @@ +--- +title: Sandbox Async +--- + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_sync/index.mdx new file mode 100644 index 0000000000..1d93d98353 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.2/sandbox_sync/index.mdx @@ -0,0 +1,1001 @@ +--- +title: Sandbox Sync +--- + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_async/index.mdx new file mode 100644 index 0000000000..ed86274b64 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_async/index.mdx @@ -0,0 +1,1038 @@ +--- +title: Sandbox Async +--- + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_sync/index.mdx new file mode 100644 index 0000000000..1d93d98353 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.3/sandbox_sync/index.mdx @@ -0,0 +1,1001 @@ +--- +title: Sandbox Sync +--- + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_async/index.mdx new file mode 100644 index 0000000000..3cd9c5c035 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_async/index.mdx @@ -0,0 +1,1038 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_sync/index.mdx new file mode 100644 index 0000000000..9569be05c4 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.4/sandbox_sync/index.mdx @@ -0,0 +1,1001 @@ +--- +title: Sandbox Sync +--- + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_async/index.mdx new file mode 100644 index 0000000000..3cd9c5c035 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_async/index.mdx @@ -0,0 +1,1038 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +async def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_sync/index.mdx new file mode 100644 index 0000000000..9569be05c4 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.5/sandbox_sync/index.mdx @@ -0,0 +1,1001 @@ +--- +title: Sandbox Sync +--- + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + +### get\_info + +```python Python +@classmethod +def get_info(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get the sandbox info. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: Domain to use for the request, defaults to `E2B_DOMAIN` environment variable +- `debug`: Debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request + +**Returns**: + +Sandbox info + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_async/index.mdx new file mode 100644 index 0000000000..74ff26ff12 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_async/index.mdx @@ -0,0 +1,1057 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_sync/index.mdx new file mode 100644 index 0000000000..a9c4da5a39 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.5.6/sandbox_sync/index.mdx @@ -0,0 +1,1021 @@ +--- +title: Sandbox Sync +--- + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..74ff26ff12 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_async/index.mdx @@ -0,0 +1,1057 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..a9c4da5a39 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.6.0/sandbox_sync/index.mdx @@ -0,0 +1,1021 @@ +--- +title: Sandbox Sync +--- + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..3d7e6c0f0b --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_async/index.mdx @@ -0,0 +1,1067 @@ +--- +title: Sandbox Async +--- + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..c0a05858b1 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.0/sandbox_sync/index.mdx @@ -0,0 +1,1031 @@ +--- +title: Sandbox Sync +--- + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Domain where the sandbox is hosted. + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..62cbc6ee26 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_async/index.mdx @@ -0,0 +1,1067 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[EntryInfo, List[EntryInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..153766b4dc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.7.1/sandbox_sync/index.mdx @@ -0,0 +1,1031 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Domain where the sandbox is hosted. + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..7b500ae42f --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_async/index.mdx @@ -0,0 +1,1088 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[WriteInfo, List[WriteInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..e34af333cc --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.8.0/sandbox_sync/index.mdx @@ -0,0 +1,1052 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Domain where the sandbox is hosted. + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..32b093ac04 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_async/index.mdx @@ -0,0 +1,1164 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +async def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +@overload +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +async def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### write + +```python Python +async def write( + path_or_files: Union[str, List[WriteEntry]], + data_or_user: Union[str, bytes, IO, Username] = "user", + user_or_request_timeout: Optional[Union[float, Username]] = None, + request_timeout_or_none: Optional[float] = None +) -> Union[WriteInfo, List[WriteInfo]] +``` + +Writes content to a file on the path. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Unique identifier of the sandbox. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[AsyncSandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None, + secure: Optional[bool] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** +- `secure`: Envd is secured with access token and cannot be used without it + +**Returns**: + +sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@classmethod +async def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connect to an existing sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = await AsyncSandbox.create() +sandbox_id = sandbox.sandbox_id + +same_sandbox = await AsyncSandbox.connect(sandbox_id) + + +### kill + +```python Python +@overload +async def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, + request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..cdb8e953da --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v1.9.0/sandbox_sync/index.mdx @@ -0,0 +1,1128 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxApiBase) +``` + + +### list + +```python Python +@classmethod +def list(cls, + api_key: Optional[str] = None, + query: Optional[SandboxQuery] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> List[ListedSandbox] +``` + +List all running sandboxes. + +**Arguments**: + +- `api_key`: API key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `query`: Filter the list of sandboxes, e.g. by metadata `SandboxQuery(metadata={"key": "value"})`, if there are multiple filters they are combined with AND. +- `domain`: Domain to use for the request, only relevant for self-hosted environments +- `debug`: Enable debug mode, all requested are then sent to localhost +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Additional headers to send with the request +- `proxy`: Proxy to use for the request + +**Returns**: + +List of running sandboxes + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +@overload +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. + +Writing to a file that already exists overwrites the file. + +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write + +```python Python +@overload +def write(files: List[WriteEntry], + user: Optional[Username] = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Sandbox + +```python Python +class Sandbox(SandboxSetup, SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### sandbox\_id + +```python Python +@property +def sandbox_id() -> str +``` + +Unique identifier of the sandbox. + + +### sandbox\_domain + +```python Python +@property +def sandbox_domain() -> str +``` + +Domain where the sandbox is hosted. + + +### \_\_init\_\_ + +```python Python +def __init__(template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + sandbox_id: Optional[str] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the new sandbox + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### connect + +```python Python +@classmethod +def connect(cls, + sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + proxy: Optional[ProxyTypes] = None) +``` + +Connects to an existing Sandbox. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `proxy`: Proxy to use for the request and for the **requests made to the returned sandbox** + +**Returns**: + +sandbox instance for the existing sandbox +@example +```python Python +sandbox = Sandbox() +sandbox_id = sandbox.sandbox_id + +same_sandbox = Sandbox.connect(sandbox_id) +``` + + +### kill + +```python Python +@overload +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(request_timeout: Optional[float] = None) -> bool +``` + +Kill the sandbox. + +**Arguments**: + +- `request_timeout`: Timeout for the request + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, request_timeout: Optional[float] = None) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, + timeout: int, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + proxy: Optional[ProxyTypes] = None) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `proxy`: Proxy to use for the request + + +### get\_info + +```python Python +@overload +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None, + headers: Optional[Dict[str, str]] = None, + proxy: Optional[ProxyTypes] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `domain`: E2B domain to use for authentication, defaults to `E2B_DOMAIN` environment variable +- `debug`: Whether to use debug mode, defaults to `E2B_DEBUG` environment variable +- `request_timeout`: Timeout for the request in **seconds** +- `headers`: Custom headers to use for the request +- `proxy`: Proxy to use for the request + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(request_timeout: Optional[float] = None) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics( + sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + api_key: Optional[str] = None, + domain: Optional[str] = None, + debug: Optional[bool] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `api_key`: E2B API Key to use for authentication, defaults to `E2B_API_KEY` environment variable +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics( + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + request_timeout: Optional[float] = None) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to current time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..a78a154345 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_async/index.mdx @@ -0,0 +1,1285 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> AsyncSandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +async def write_files( + files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +Writes a list of files to the filesystem. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandboxPaginator + +```python Python +class AsyncSandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = AsyncSandbox.list() + +while paginator.has_next: + sandboxes = await paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +async def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### connect + +```python Python +@overload +@classmethod +async def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await AsyncSandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = await AsyncSandbox.connect(sandbox.sandbox_id)) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### kill + +```python Python +@overload +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +async def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@overload +@staticmethod +async def beta_pause(sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..486cabaea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.0/sandbox_sync/index.mdx @@ -0,0 +1,1244 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> SandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +def write_files(files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## SandboxPaginator + +```python Python +class SandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = Sandbox.list() + +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +:deprecated: This constructor is deprecated + +Use `Sandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox.create() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() + + +### connect + +```python Python +@overload +@classmethod +def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +Sandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() +``` + + +### kill + +```python Python +@overload +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + + +### beta\_pause + +```python Python +@overload +@classmethod +def beta_pause(cls, sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..a78a154345 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_async/index.mdx @@ -0,0 +1,1285 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> AsyncSandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +async def write_files( + files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +Writes a list of files to the filesystem. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandboxPaginator + +```python Python +class AsyncSandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = AsyncSandbox.list() + +while paginator.has_next: + sandboxes = await paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +async def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### connect + +```python Python +@overload +@classmethod +async def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await AsyncSandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = await AsyncSandbox.connect(sandbox.sandbox_id)) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### kill + +```python Python +@overload +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +async def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@overload +@staticmethod +async def beta_pause(sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..486cabaea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.1/sandbox_sync/index.mdx @@ -0,0 +1,1244 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> SandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +def write_files(files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## SandboxPaginator + +```python Python +class SandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = Sandbox.list() + +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +:deprecated: This constructor is deprecated + +Use `Sandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox.create() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() + + +### connect + +```python Python +@overload +@classmethod +def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +Sandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() +``` + + +### kill + +```python Python +@overload +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + + +### beta\_pause + +```python Python +@overload +@classmethod +def beta_pause(cls, sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/exceptions/index.mdx new file mode 100644 index 0000000000..6b5220bd78 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(SandboxException) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_async/index.mdx new file mode 100644 index 0000000000..a78a154345 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_async/index.mdx @@ -0,0 +1,1285 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> AsyncSandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +async def write_files( + files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +Writes a list of files to the filesystem. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandboxPaginator + +```python Python +class AsyncSandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = AsyncSandbox.list() + +while paginator.has_next: + sandboxes = await paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +async def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### connect + +```python Python +@overload +@classmethod +async def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await AsyncSandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = await AsyncSandbox.connect(sandbox.sandbox_id)) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### kill + +```python Python +@overload +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +async def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@overload +@staticmethod +async def beta_pause(sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_sync/index.mdx new file mode 100644 index 0000000000..486cabaea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.0.2/sandbox_sync/index.mdx @@ -0,0 +1,1244 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> SandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +def write_files(files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## SandboxPaginator + +```python Python +class SandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = Sandbox.list() + +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +:deprecated: This constructor is deprecated + +Use `Sandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox.create() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() + + +### connect + +```python Python +@overload +@classmethod +def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +Sandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() +``` + + +### kill + +```python Python +@overload +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + + +### beta\_pause + +```python Python +@overload +@classmethod +def beta_pause(cls, sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/exceptions/index.mdx new file mode 100644 index 0000000000..e02a276a10 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(Exception) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_async/index.mdx new file mode 100644 index 0000000000..a78a154345 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_async/index.mdx @@ -0,0 +1,1285 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> AsyncSandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +async def write_files( + files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +Writes a list of files to the filesystem. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandboxPaginator + +```python Python +class AsyncSandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = AsyncSandbox.list() + +while paginator.has_next: + sandboxes = await paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +async def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### connect + +```python Python +@overload +@classmethod +async def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await AsyncSandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = await AsyncSandbox.connect(sandbox.sandbox_id)) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### kill + +```python Python +@overload +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +async def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@overload +@staticmethod +async def beta_pause(sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_sync/index.mdx new file mode 100644 index 0000000000..486cabaea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.0/sandbox_sync/index.mdx @@ -0,0 +1,1244 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> SandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +def write_files(files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## SandboxPaginator + +```python Python +class SandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = Sandbox.list() + +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +:deprecated: This constructor is deprecated + +Use `Sandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox.create() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() + + +### connect + +```python Python +@overload +@classmethod +def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +Sandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() +``` + + +### kill + +```python Python +@overload +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + + +### beta\_pause + +```python Python +@overload +@classmethod +def beta_pause(cls, sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/exceptions/index.mdx new file mode 100644 index 0000000000..e02a276a10 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(Exception) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_async/index.mdx new file mode 100644 index 0000000000..a78a154345 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_async/index.mdx @@ -0,0 +1,1285 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> AsyncSandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +async def write_files( + files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +Writes a list of files to the filesystem. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandboxPaginator + +```python Python +class AsyncSandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = AsyncSandbox.list() + +while paginator.has_next: + sandboxes = await paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +async def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### connect + +```python Python +@overload +@classmethod +async def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await AsyncSandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = await AsyncSandbox.connect(sandbox.sandbox_id)) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### kill + +```python Python +@overload +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +async def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@overload +@staticmethod +async def beta_pause(sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_sync/index.mdx new file mode 100644 index 0000000000..486cabaea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.1/sandbox_sync/index.mdx @@ -0,0 +1,1244 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> SandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +def write_files(files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## SandboxPaginator + +```python Python +class SandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = Sandbox.list() + +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +:deprecated: This constructor is deprecated + +Use `Sandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox.create() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() + + +### connect + +```python Python +@overload +@classmethod +def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +Sandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() +``` + + +### kill + +```python Python +@overload +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + + +### beta\_pause + +```python Python +@overload +@classmethod +def beta_pause(cls, sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/exceptions/index.mdx new file mode 100644 index 0000000000..e02a276a10 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(Exception) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_async/index.mdx new file mode 100644 index 0000000000..a78a154345 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_async/index.mdx @@ -0,0 +1,1285 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> AsyncSandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +async def write_files( + files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +Writes a list of files to the filesystem. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandboxPaginator + +```python Python +class AsyncSandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = AsyncSandbox.list() + +while paginator.has_next: + sandboxes = await paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +async def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### connect + +```python Python +@overload +@classmethod +async def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await AsyncSandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = await AsyncSandbox.connect(sandbox.sandbox_id)) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### kill + +```python Python +@overload +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +async def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@overload +@staticmethod +async def beta_pause(sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_sync/index.mdx new file mode 100644 index 0000000000..486cabaea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.2/sandbox_sync/index.mdx @@ -0,0 +1,1244 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> SandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +def write_files(files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## SandboxPaginator + +```python Python +class SandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = Sandbox.list() + +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +:deprecated: This constructor is deprecated + +Use `Sandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox.create() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() + + +### connect + +```python Python +@overload +@classmethod +def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +Sandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() +``` + + +### kill + +```python Python +@overload +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + + +### beta\_pause + +```python Python +@overload +@classmethod +def beta_pause(cls, sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/exceptions/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/exceptions/index.mdx new file mode 100644 index 0000000000..e02a276a10 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/exceptions/index.mdx @@ -0,0 +1,88 @@ +--- +title: Exceptions +--- + + + + +## SandboxException + +```python Python +class SandboxException(Exception) +``` + +Base class for all sandbox errors. + +Raised when a general sandbox exception occurs. + + +## TimeoutException + +```python Python +class TimeoutException(SandboxException) +``` + +Raised when a timeout occurs. + +The `unavailable` exception type is caused by sandbox timeout. + +The `canceled` exception type is caused by exceeding request timeout. + +The `deadline_exceeded` exception type is caused by exceeding the timeout for process, watch, etc. + +The `unknown` exception type is sometimes caused by the sandbox timeout when the request is not processed correctly. + + +## InvalidArgumentException + +```python Python +class InvalidArgumentException(SandboxException) +``` + +Raised when an invalid argument is provided. + + +## NotEnoughSpaceException + +```python Python +class NotEnoughSpaceException(SandboxException) +``` + +Raised when there is not enough disk space. + + +## NotFoundException + +```python Python +class NotFoundException(SandboxException) +``` + +Raised when a resource is not found. + + +## AuthenticationException + +```python Python +class AuthenticationException(Exception) +``` + +Raised when authentication fails. + + +## TemplateException + +```python Python +class TemplateException(SandboxException) +``` + +Exception raised when the template uses old envd version. It isn't compatible with the new SDK. + + +## RateLimitException + +```python Python +class RateLimitException(SandboxException) +``` + +Raised when the API rate limit is exceeded. + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_async/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_async/index.mdx new file mode 100644 index 0000000000..a78a154345 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_async/index.mdx @@ -0,0 +1,1285 @@ +--- +title: Sandbox Async +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> AsyncSandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +async def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: str, + request_timeout: Optional[float] = None) -> None +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +async def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + +### connect + +```python Python +async def connect( + pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None, + on_stdout: Optional[OutputHandler[Stdout]] = None, + on_stderr: Optional[OutputHandler[Stderr]] = None +) -> AsyncCommandHandle +``` + +Connects to a running command. + +You can use `AsyncCommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Request timeout in **seconds** +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output + +**Returns**: + +`AsyncCommandHandle` handle to interact with the running command + + + + +## AsyncCommandHandle + +```python Python +class AsyncCommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### stdout + +```python Python +@property +def stdout() +``` + +Command stdout output. + + +### stderr + +```python Python +@property +def stderr() +``` + +Command stderr output. + + +### error + +```python Python +@property +def error() +``` + +Command execution error message. + + +### exit\_code + +```python Python +@property +def exit_code() +``` + +Command execution exit code. + +`0` if the command finished successfully. + +It is `None` if the command is still running. + + +### disconnect + +```python Python +async def disconnect() -> None +``` + +Disconnects from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +async def wait() -> CommandResult +``` + +Wait for the command to finish and return the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +async def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command + +**Returns**: + +`True` if the command was killed successfully, `False` if the command was not found + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +async def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +async def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +async def create( + size: PtySize, + on_data: OutputHandler[PtyOutput], + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> AsyncCommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `on_data`: Callback to handle PTY data +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +async def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds** + + + + +## AsyncWatchHandle + +```python Python +class AsyncWatchHandle() +``` + +Handle for watching a directory in the sandbox filesystem. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +async def stop() +``` + +Stop watching the directory. + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +async def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +async def read( + path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> AsyncIterator[bytes] +``` + +Read file content as a `AsyncIterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `AsyncIterator[bytes]` + + +### write + +```python Python +async def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +async def write_files( + files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes multiple files. + +Writes a list of files to the filesystem. +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +async def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +async def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +async def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +async def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +async def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +async def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +async def watch_dir(path: str, + on_event: OutputHandler[FilesystemEvent], + on_exit: Optional[OutputHandler[Exception]] = None, + user: Username = "user", + request_timeout: Optional[float] = None, + timeout: Optional[float] = 60, + recursive: bool = False) -> AsyncWatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `on_event`: Callback to call on each event in the directory +- `on_exit`: Callback to call when the watching ends +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `timeout`: Timeout for the watch operation in **seconds**. Using `0` will not limit the watch time +- `recursive`: Watch directory recursively + +**Returns**: + +`AsyncWatchHandle` object for stopping watching directory + + + + +## AsyncSandboxPaginator + +```python Python +class AsyncSandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = AsyncSandbox.list() + +while paginator.has_next: + sandboxes = await paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +async def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## AsyncSandbox + +```python Python +class AsyncSandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `AsyncSandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import AsyncSandbox + +sandbox = await AsyncSandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +Use `AsyncSandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +async def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.is_running() # Returns True + +await sandbox.kill() +await sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +async def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: Optional[bool] = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### connect + +```python Python +@overload +@classmethod +async def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await AsyncSandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = await AsyncSandbox.connect(sandbox.sandbox_id)) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +async def connect(timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = await AsyncSandbox.create() +await sandbox.beta_pause() + +same_sandbox = await sandbox.connect() +``` + + +### kill + +```python Python +@overload +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +async def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +async def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +async def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +async def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the specified sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +async def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +async def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +async def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +async def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +async def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@overload +@staticmethod +async def beta_pause(sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +async def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_sync/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_sync/index.mdx new file mode 100644 index 0000000000..486cabaea5 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk-reference/python-sdk/v2.1.3/sandbox_sync/index.mdx @@ -0,0 +1,1244 @@ +--- +title: Sandbox Sync +--- + + + + +## SandboxApi + +```python Python +class SandboxApi(SandboxBase) +``` + + +### list + +```python Python +@staticmethod +def list(query: Optional[SandboxQuery] = None, + limit: Optional[int] = None, + next_token: Optional[str] = None, + **opts: Unpack[ApiParams]) -> SandboxPaginator +``` + +List all running sandboxes. + +**Arguments**: + +- `query`: Filter the list of sandboxes by metadata or state, e.g. `SandboxListQuery(metadata={"key": "value"})` or `SandboxListQuery(state=[SandboxState.RUNNING])` +- `limit`: Maximum number of sandboxes to return per page +- `next_token`: Token for pagination + +**Returns**: + +List of running sandboxes + + + + +## Commands + +```python Python +class Commands() +``` + +Module for executing commands in the sandbox. + + +### list + +```python Python +def list(request_timeout: Optional[float] = None) -> List[ProcessInfo] +``` + +Lists all running commands and PTY sessions. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of running commands and PTY sessions + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kills a running command specified by its process ID. + +It uses `SIGKILL` signal to kill the command. + +**Arguments**: + +- `pid`: Process ID of the command. You can get the list of processes using `sandbox.commands.list()` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the command was killed, `False` if the command was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, data: str, request_timeout: Optional[float] = None) +``` + +Send data to command stdin. + +:param pid Process ID of the command. You can get the list of processes using `sandbox.commands.list()`. +:param data: Data to send to the command +:param request_timeout: Timeout for the request in **seconds** + + + +### run + +```python Python +@overload +def run(cmd: str, + background: Union[Literal[False], None] = None, + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandResult +``` + +Start a new command and wait until it finishes executing. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: **`False` if the command should be executed in the foreground**, `True` if the command should be executed in the background +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `on_stdout`: Callback for command stdout output +- `on_stderr`: Callback for command stderr output +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandResult` result of the command execution + + +### run + +```python Python +@overload +def run(cmd: str, + background: Literal[True], + envs: Optional[Dict[str, str]] = None, + user: Username = "user", + cwd: Optional[str] = None, + on_stdout: None = None, + on_stderr: None = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new command and return a handle to interact with it. + +**Arguments**: + +- `cmd`: Command to execute +- `background`: `False` if the command should be executed in the foreground, **`True` if the command should be executed in the background** +- `envs`: Environment variables used for the command +- `user`: User to run the command as +- `cwd`: Working directory to run the command +- `timeout`: Timeout for the command connection in **seconds**. Using `0` will not limit the command connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + +### connect + +```python Python +def connect(pid: int, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) +``` + +Connects to a running command. + +You can use `CommandHandle.wait()` to wait for the command to finish and get execution results. + +**Arguments**: + +- `pid`: Process ID of the command to connect to. You can get the list of processes using `sandbox.commands.list()` +- `timeout`: Timeout for the connection in **seconds**. Using `0` will not limit the connection time +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`CommandHandle` handle to interact with the running command + + + + +## CommandHandle + +```python Python +class CommandHandle() +``` + +Command execution handle. + +It provides methods for waiting for the command to finish, retrieving stdout/stderr, and killing the command. + + +### pid + +```python Python +@property +def pid() +``` + +Command process ID. + + +### \_\_iter\_\_ + +```python Python +def __iter__() +``` + +Iterate over the command output. + +**Returns**: + +Generator of command outputs + + +### disconnect + +```python Python +def disconnect() -> None +``` + +Disconnect from the command. + +The command is not killed, but SDK stops receiving events from the command. +You can reconnect to the command using `sandbox.commands.connect` method. + + +### wait + +```python Python +def wait(on_pty: Optional[Callable[[PtyOutput], None]] = None, + on_stdout: Optional[Callable[[str], None]] = None, + on_stderr: Optional[Callable[[str], None]] = None) -> CommandResult +``` + +Wait for the command to finish and returns the result. + +If the command exits with a non-zero exit code, it throws a `CommandExitException`. + +**Arguments**: + +- `on_pty`: Callback for pty output +- `on_stdout`: Callback for stdout output +- `on_stderr`: Callback for stderr output + +**Returns**: + +`CommandResult` result of command execution + + +### kill + +```python Python +def kill() -> bool +``` + +Kills the command. + +It uses `SIGKILL` signal to kill the command. + +**Returns**: + +Whether the command was killed successfully + + + + +## Pty + +```python Python +class Pty() +``` + +Module for interacting with PTYs (pseudo-terminals) in the sandbox. + + +### kill + +```python Python +def kill(pid: int, request_timeout: Optional[float] = None) -> bool +``` + +Kill PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`true` if the PTY was killed, `false` if the PTY was not found + + +### send\_stdin + +```python Python +def send_stdin(pid: int, + data: bytes, + request_timeout: Optional[float] = None) -> None +``` + +Send input to a PTY. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `data`: Input data to send +- `request_timeout`: Timeout for the request in **seconds** + + +### create + +```python Python +def create(size: PtySize, + user: Username = "user", + cwd: Optional[str] = None, + envs: Optional[Dict[str, str]] = None, + timeout: Optional[float] = 60, + request_timeout: Optional[float] = None) -> CommandHandle +``` + +Start a new PTY (pseudo-terminal). + +**Arguments**: + +- `size`: Size of the PTY +- `user`: User to use for the PTY +- `cwd`: Working directory for the PTY +- `envs`: Environment variables for the PTY +- `timeout`: Timeout for the PTY in **seconds** +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Handle to interact with the PTY + + +### resize + +```python Python +def resize(pid: int, + size: PtySize, + request_timeout: Optional[float] = None) -> None +``` + +Resize PTY. + +Call this when the terminal window is resized and the number of columns and rows has changed. + +**Arguments**: + +- `pid`: Process ID of the PTY +- `size`: New size of the PTY +- `request_timeout`: Timeout for the request in **seconds**s + + + + +## WatchHandle + +```python Python +class WatchHandle() +``` + +Handle for watching filesystem events. +It is used to get the latest events that have occurred in the watched directory. + +Use `.stop()` to stop watching the directory. + + +### stop + +```python Python +def stop() +``` + +Stop watching the directory. +After you stop the watcher you won't be able to get the events anymore. + + +### get\_new\_events + +```python Python +def get_new_events() -> List[FilesystemEvent] +``` + +Get the latest events that have occurred in the watched directory since the last call, or from the beginning of the watching, up until now. + +**Returns**: + +List of filesystem events + + + + +## Filesystem + +```python Python +class Filesystem() +``` + +Module for interacting with the filesystem in the sandbox. + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["text"] = "text", + user: Username = "user", + request_timeout: Optional[float] = None) -> str +``` + +Read file content as a `str`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`text` by default +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `str` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["bytes"], + user: Username = "user", + request_timeout: Optional[float] = None) -> bytearray +``` + +Read file content as a `bytearray`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`bytes` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as a `bytearray` + + +### read + +```python Python +@overload +def read(path: str, + format: Literal["stream"], + user: Username = "user", + request_timeout: Optional[float] = None) -> Iterator[bytes] +``` + +Read file content as a `Iterator[bytes]`. + +**Arguments**: + +- `path`: Path to the file +- `user`: Run the operation as this user +- `format`: Format of the file content—`stream` +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +File content as an `Iterator[bytes]` + + +### write + +```python Python +def write(path: str, + data: Union[str, bytes, IO], + user: Username = "user", + request_timeout: Optional[float] = None) -> WriteInfo +``` + +Write content to a file on the path. + +Writing to a file that doesn't exist creates the file. +Writing to a file that already exists overwrites the file. +Writing to a file at path that doesn't exist creates the necessary directories. + +**Arguments**: + +- `path`: Path to the file +- `data`: Data to write to the file, can be a `str`, `bytes`, or `IO`. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the written file + + +### write\_files + +```python Python +def write_files(files: List[WriteEntry], + user: Username = "user", + request_timeout: Optional[float] = None) -> List[WriteInfo] +``` + +Writes a list of files to the filesystem. + +When writing to a file that doesn't exist, the file will get created. +When writing to a file that already exists, the file will get overwritten. +When writing to a file that's in a directory that doesn't exist, you'll get an error. + +**Arguments**: + +- `files`: list of files to write as `WriteEntry` objects, each containing `path` and `data` +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request + +**Returns**: + +Information about the written files + + +### list + +```python Python +def list(path: str, + depth: Optional[int] = 1, + user: Username = "user", + request_timeout: Optional[float] = None) -> List[EntryInfo] +``` + +List entries in a directory. + +**Arguments**: + +- `path`: Path to the directory +- `depth`: Depth of the directory to list +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +List of entries in the directory + + +### exists + +```python Python +def exists(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Check if a file or a directory exists. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the file or directory exists, `False` otherwise + + +### get\_info + +```python Python +def get_info(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Get information about a file or directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the file or directory like name, type, and path + + +### remove + +```python Python +def remove(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> None +``` + +Remove a file or a directory. + +**Arguments**: + +- `path`: Path to a file or a directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + + +### rename + +```python Python +def rename(old_path: str, + new_path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> EntryInfo +``` + +Rename a file or directory. + +**Arguments**: + +- `old_path`: Path to the file or directory to rename +- `new_path`: New path to the file or directory +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +Information about the renamed file or directory + + +### make\_dir + +```python Python +def make_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None) -> bool +``` + +Create a new directory and all directories along the way if needed on the specified path. + +**Arguments**: + +- `path`: Path to a new directory. For example '/dirA/dirB' when creating 'dirB'. +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the directory was created, `False` if the directory already exists + + +### watch\_dir + +```python Python +def watch_dir(path: str, + user: Username = "user", + request_timeout: Optional[float] = None, + recursive: bool = False) -> WatchHandle +``` + +Watch directory for filesystem events. + +**Arguments**: + +- `path`: Path to a directory to watch +- `user`: Run the operation as this user +- `request_timeout`: Timeout for the request in **seconds** +- `recursive`: Watch directory recursively + +**Returns**: + +`WatchHandle` object for stopping watching directory + + + + +## SandboxPaginator + +```python Python +class SandboxPaginator(SandboxPaginatorBase) +``` + +Paginator for listing sandboxes. + +**Example**: + +```python Python +paginator = Sandbox.list() + +while paginator.has_next: + sandboxes = paginator.next_items() + print(sandboxes) +``` + + +### next\_items + +```python Python +def next_items() -> List[SandboxInfo] +``` + +Returns the next page of sandboxes. + +Call this method only if `has_next` is `True`, otherwise it will raise an exception. + +**Returns**: + +List of sandboxes + + + + +## Sandbox + +```python Python +class Sandbox(SandboxApi) +``` + +E2B cloud sandbox is a secure and isolated cloud environment. + +The sandbox allows you to: +- Access Linux OS +- Create, list, and delete files and directories +- Run commands +- Run isolated code +- Access the internet + +Check docs [here](/). + +Use the `Sandbox.create()` to create a new sandbox. + +**Example**: + +```python Python +from e2b import Sandbox + +sandbox = Sandbox.create() +``` + + +### files + +```python Python +@property +def files() -> Filesystem +``` + +Module for interacting with the sandbox filesystem. + + +### commands + +```python Python +@property +def commands() -> Commands +``` + +Module for running commands in the sandbox. + + +### pty + +```python Python +@property +def pty() -> Pty +``` + +Module for interacting with the sandbox pseudo-terminal. + + +### \_\_init\_\_ + +```python Python +def __init__(**opts: Unpack[SandboxOpts]) +``` + +:deprecated: This constructor is deprecated + +Use `Sandbox.create()` to create a new sandbox instead. + + +### is\_running + +```python Python +def is_running(request_timeout: Optional[float] = None) -> bool +``` + +Check if the sandbox is running. + +**Arguments**: + +- `request_timeout`: Timeout for the request in **seconds** + +**Returns**: + +`True` if the sandbox is running, `False` otherwise +Example +```python Python +sandbox = Sandbox.create() +sandbox.is_running() # Returns True + +sandbox.kill() +sandbox.is_running() # Returns False +``` + + +### create + +```python Python +@classmethod +def create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### connect + +```python Python +@overload +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() + + +### connect + +```python Python +@overload +@classmethod +def connect(cls, + sandbox_id: str, + timeout: Optional[int] = None, + **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +Sandbox.beta_pause(sandbox.sandbox_id) + +same_sandbox = Sandbox.connect(sandbox.sandbox_id) +``` + + +### connect + +```python Python +@class_method_variant("_cls_connect") +def connect(timeout: Optional[int] = None, **opts: Unpack[ApiParams]) -> Self +``` + +Connect to a sandbox. If the sandbox is paused, it will be automatically resumed. + +Sandbox must be either running or be paused. + +With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc). + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + +**Returns**: + +A running sandbox instance +@example +```python Python +sandbox = Sandbox.create() +sandbox.beta_pause() + +same_sandbox = sandbox.connect() +``` + + +### kill + +```python Python +@overload +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@overload +@staticmethod +def kill(sandbox_id: str, **opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### kill + +```python Python +@class_method_variant("_cls_kill") +def kill(**opts: Unpack[ApiParams]) -> bool +``` + +Kill the sandbox specified by sandbox ID. + +**Returns**: + +`True` if the sandbox was killed, `False` if the sandbox was not found + + +### set\_timeout + +```python Python +@overload +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@overload +@staticmethod +def set_timeout(sandbox_id: str, timeout: int, + **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox specified by sandbox ID. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `timeout`: Timeout for the sandbox in **seconds** + + +### set\_timeout + +```python Python +@class_method_variant("_cls_set_timeout") +def set_timeout(timeout: int, **opts: Unpack[ApiParams]) -> None +``` + +Set the timeout of the sandbox. + +After the timeout expires, the sandbox will be automatically killed. +This method can extend or reduce the sandbox timeout set when creating the sandbox or from the last call to `.set_timeout`. + +The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. + +**Arguments**: + +- `timeout`: Timeout for the sandbox in **seconds** + + +### get\_info + +```python Python +@overload +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@overload +@staticmethod +def get_info(sandbox_id: str, **opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + +**Returns**: + +Sandbox info + + +### get\_info + +```python Python +@class_method_variant("_cls_get_info") +def get_info(**opts: Unpack[ApiParams]) -> SandboxInfo +``` + +Get sandbox information like sandbox ID, template, metadata, started at/end at date. + +**Returns**: + +Sandbox info + + +### get\_metrics + +```python Python +@overload +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the current sandbox. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@overload +@staticmethod +def get_metrics(sandbox_id: str, + start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### get\_metrics + +```python Python +@class_method_variant("_cls_get_metrics") +def get_metrics(start: Optional[datetime.datetime] = None, + end: Optional[datetime.datetime] = None, + **opts: Unpack[ApiParams]) -> List[SandboxMetrics] +``` + +Get the metrics of the sandbox specified by sandbox ID. + +**Arguments**: + +- `start`: Start time for the metrics, defaults to the start of the sandbox +- `end`: End time for the metrics, defaults to the current time + +**Returns**: + +List of sandbox metrics containing CPU, memory and disk usage information + + +### beta\_create + +```python Python +@classmethod +def beta_create(cls, + template: Optional[str] = None, + timeout: Optional[int] = None, + auto_pause: bool = False, + metadata: Optional[Dict[str, str]] = None, + envs: Optional[Dict[str, str]] = None, + secure: bool = True, + allow_internet_access: bool = True, + **opts: Unpack[ApiParams]) -> Self +``` + +[BETA] This feature is in beta and may change in the future. + +Create a new sandbox. + +By default, the sandbox is created from the default `base` sandbox template. + +**Arguments**: + +- `template`: Sandbox template name or ID +- `timeout`: Timeout for the sandbox in **seconds**, default to 300 seconds. The maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users. +- `auto_pause`: Automatically pause the sandbox after the timeout expires. Defaults to `False`. +- `metadata`: Custom metadata for the sandbox +- `envs`: Custom environment variables for the sandbox +- `secure`: Envd is secured with access token and cannot be used without it, defaults to `True`. +- `allow_internet_access`: Allow sandbox to access the internet, defaults to `True`. + +**Returns**: + +A Sandbox instance for the new sandbox +Use this method instead of using the constructor to create a new sandbox. + + +### beta\_pause + +```python Python +@overload +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + + +### beta\_pause + +```python Python +@overload +@classmethod +def beta_pause(cls, sandbox_id: str, **opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox specified by sandbox ID. + +**Arguments**: + +- `sandbox_id`: Sandbox ID + + +### beta\_pause + +```python Python +@class_method_variant("_cls_pause") +def beta_pause(**opts: Unpack[ApiParams]) -> None +``` + +[BETA] This feature is in beta and may change in the future. + +Pause the sandbox. + +**Returns**: + +Sandbox ID that can be used to resume the sandbox + diff --git a/apps/web/src/app/(docs)/mintlify-docs/sdk_navigation.json b/apps/web/src/app/(docs)/mintlify-docs/sdk_navigation.json new file mode 100644 index 0000000000..94c094999d --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/sdk_navigation.json @@ -0,0 +1,2398 @@ +[ + { + "dropdown": "CLI", + "icon": "terminal", + "versions": [ + { + "version": "v2.2.0@latest", + "groups": [ + { + "group": "CLI v2.2.0", + "pages": [ + "sdk-reference/cli/v2.2.0/auth/index", + "sdk-reference/cli/v2.2.0/sandbox/index", + "sdk-reference/cli/v2.2.0/template/index" + ] + } + ] + }, + { + "version": "v2.1.0", + "groups": [ + { + "group": "CLI v2.1.0", + "pages": [ + "sdk-reference/cli/v2.1.0/auth/index", + "sdk-reference/cli/v2.1.0/sandbox/index", + "sdk-reference/cli/v2.1.0/template/index" + ] + } + ] + }, + { + "version": "v2.0.3", + "groups": [ + { + "group": "CLI v2.0.3", + "pages": [ + "sdk-reference/cli/v2.0.3/auth/index", + "sdk-reference/cli/v2.0.3/sandbox/index", + "sdk-reference/cli/v2.0.3/template/index" + ] + } + ] + }, + { + "version": "v2.0.2", + "groups": [ + { + "group": "CLI v2.0.2", + "pages": [ + "sdk-reference/cli/v2.0.2/auth/index", + "sdk-reference/cli/v2.0.2/sandbox/index", + "sdk-reference/cli/v2.0.2/template/index" + ] + } + ] + }, + { + "version": "v2.0.1", + "groups": [ + { + "group": "CLI v2.0.1", + "pages": [ + "sdk-reference/cli/v2.0.1/auth/index", + "sdk-reference/cli/v2.0.1/sandbox/index", + "sdk-reference/cli/v2.0.1/template/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "CLI v2.0.0", + "pages": [ + "sdk-reference/cli/v2.0.0/auth/index", + "sdk-reference/cli/v2.0.0/sandbox/index", + "sdk-reference/cli/v2.0.0/template/index" + ] + } + ] + }, + { + "version": "v1.9.2", + "groups": [ + { + "group": "CLI v1.9.2", + "pages": [ + "sdk-reference/cli/v1.9.2/auth/index", + "sdk-reference/cli/v1.9.2/sandbox/index", + "sdk-reference/cli/v1.9.2/template/index" + ] + } + ] + }, + { + "version": "v1.9.1", + "groups": [ + { + "group": "CLI v1.9.1", + "pages": [ + "sdk-reference/cli/v1.9.1/auth/index", + "sdk-reference/cli/v1.9.1/sandbox/index", + "sdk-reference/cli/v1.9.1/template/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "CLI v1.9.0", + "pages": [ + "sdk-reference/cli/v1.9.0/auth/index", + "sdk-reference/cli/v1.9.0/sandbox/index", + "sdk-reference/cli/v1.9.0/template/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "CLI v1.8.0", + "pages": [ + "sdk-reference/cli/v1.8.0/auth/index", + "sdk-reference/cli/v1.8.0/sandbox/index", + "sdk-reference/cli/v1.8.0/template/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "CLI v1.7.0", + "pages": [ + "sdk-reference/cli/v1.7.0/auth/index", + "sdk-reference/cli/v1.7.0/sandbox/index", + "sdk-reference/cli/v1.7.0/template/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "CLI v1.6.0", + "pages": [ + "sdk-reference/cli/v1.6.0/auth/index", + "sdk-reference/cli/v1.6.0/sandbox/index", + "sdk-reference/cli/v1.6.0/template/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "CLI v1.5.2", + "pages": [ + "sdk-reference/cli/v1.5.2/auth/index", + "sdk-reference/cli/v1.5.2/sandbox/index", + "sdk-reference/cli/v1.5.2/template/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "CLI v1.5.1", + "pages": [ + "sdk-reference/cli/v1.5.1/auth/index", + "sdk-reference/cli/v1.5.1/sandbox/index", + "sdk-reference/cli/v1.5.1/template/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "CLI v1.5.0", + "pages": [ + "sdk-reference/cli/v1.5.0/auth/index", + "sdk-reference/cli/v1.5.0/sandbox/index", + "sdk-reference/cli/v1.5.0/template/index" + ] + } + ] + }, + { + "version": "v1.4.3", + "groups": [ + { + "group": "CLI v1.4.3", + "pages": [ + "sdk-reference/cli/v1.4.3/auth/index", + "sdk-reference/cli/v1.4.3/sandbox/index", + "sdk-reference/cli/v1.4.3/template/index" + ] + } + ] + }, + { + "version": "v1.4.2", + "groups": [ + { + "group": "CLI v1.4.2", + "pages": [ + "sdk-reference/cli/v1.4.2/auth/index", + "sdk-reference/cli/v1.4.2/sandbox/index", + "sdk-reference/cli/v1.4.2/template/index" + ] + } + ] + }, + { + "version": "v1.4.1", + "groups": [ + { + "group": "CLI v1.4.1", + "pages": [ + "sdk-reference/cli/v1.4.1/auth/index", + "sdk-reference/cli/v1.4.1/sandbox/index", + "sdk-reference/cli/v1.4.1/template/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "CLI v1.4.0", + "pages": [ + "sdk-reference/cli/v1.4.0/auth/index", + "sdk-reference/cli/v1.4.0/sandbox/index", + "sdk-reference/cli/v1.4.0/template/index" + ] + } + ] + }, + { + "version": "v1.3.4", + "groups": [ + { + "group": "CLI v1.3.4", + "pages": [ + "sdk-reference/cli/v1.3.4/auth/index", + "sdk-reference/cli/v1.3.4/sandbox/index", + "sdk-reference/cli/v1.3.4/template/index" + ] + } + ] + }, + { + "version": "v1.3.3", + "groups": [ + { + "group": "CLI v1.3.3", + "pages": [ + "sdk-reference/cli/v1.3.3/auth/index", + "sdk-reference/cli/v1.3.3/sandbox/index", + "sdk-reference/cli/v1.3.3/template/index" + ] + } + ] + }, + { + "version": "v1.3.2", + "groups": [ + { + "group": "CLI v1.3.2", + "pages": [ + "sdk-reference/cli/v1.3.2/auth/index", + "sdk-reference/cli/v1.3.2/sandbox/index", + "sdk-reference/cli/v1.3.2/template/index" + ] + } + ] + }, + { + "version": "v1.3.1", + "groups": [ + { + "group": "CLI v1.3.1", + "pages": [ + "sdk-reference/cli/v1.3.1/auth/index", + "sdk-reference/cli/v1.3.1/sandbox/index", + "sdk-reference/cli/v1.3.1/template/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "CLI v1.3.0", + "pages": [ + "sdk-reference/cli/v1.3.0/auth/index", + "sdk-reference/cli/v1.3.0/sandbox/index", + "sdk-reference/cli/v1.3.0/template/index" + ] + } + ] + }, + { + "version": "v1.2.3", + "groups": [ + { + "group": "CLI v1.2.3", + "pages": [ + "sdk-reference/cli/v1.2.3/auth/index", + "sdk-reference/cli/v1.2.3/sandbox/index", + "sdk-reference/cli/v1.2.3/template/index" + ] + } + ] + }, + { + "version": "v1.2.2", + "groups": [ + { + "group": "CLI v1.2.2", + "pages": [ + "sdk-reference/cli/v1.2.2/auth/index", + "sdk-reference/cli/v1.2.2/sandbox/index", + "sdk-reference/cli/v1.2.2/template/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "CLI v1.2.1", + "pages": [ + "sdk-reference/cli/v1.2.1/auth/index", + "sdk-reference/cli/v1.2.1/sandbox/index", + "sdk-reference/cli/v1.2.1/template/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "CLI v1.2.0", + "pages": [ + "sdk-reference/cli/v1.2.0/auth/index", + "sdk-reference/cli/v1.2.0/sandbox/index", + "sdk-reference/cli/v1.2.0/template/index" + ] + } + ] + }, + { + "version": "v1.0.10", + "groups": [ + { + "group": "CLI v1.0.10", + "pages": [ + "sdk-reference/cli/v1.0.10/auth/index", + "sdk-reference/cli/v1.0.10/sandbox/index", + "sdk-reference/cli/v1.0.10/template/index" + ] + } + ] + }, + { + "version": "v1.0.9", + "groups": [ + { + "group": "CLI v1.0.9", + "pages": [ + "sdk-reference/cli/v1.0.9/auth/index", + "sdk-reference/cli/v1.0.9/sandbox/index", + "sdk-reference/cli/v1.0.9/template/index" + ] + } + ] + }, + { + "version": "v1.0.8", + "groups": [ + { + "group": "CLI v1.0.8", + "pages": [ + "sdk-reference/cli/v1.0.8/auth/index", + "sdk-reference/cli/v1.0.8/sandbox/index", + "sdk-reference/cli/v1.0.8/template/index" + ] + } + ] + }, + { + "version": "v1.0.7", + "groups": [ + { + "group": "CLI v1.0.7", + "pages": [ + "sdk-reference/cli/v1.0.7/auth/index", + "sdk-reference/cli/v1.0.7/sandbox/index", + "sdk-reference/cli/v1.0.7/template/index" + ] + } + ] + }, + { + "version": "v1.0.6", + "groups": [ + { + "group": "CLI v1.0.6", + "pages": [ + "sdk-reference/cli/v1.0.6/auth/index", + "sdk-reference/cli/v1.0.6/sandbox/index", + "sdk-reference/cli/v1.0.6/template/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "CLI v1.0.5", + "pages": [ + "sdk-reference/cli/v1.0.5/auth/index", + "sdk-reference/cli/v1.0.5/sandbox/index", + "sdk-reference/cli/v1.0.5/template/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "CLI v1.0.4", + "pages": [ + "sdk-reference/cli/v1.0.4/auth/index", + "sdk-reference/cli/v1.0.4/sandbox/index", + "sdk-reference/cli/v1.0.4/template/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "CLI v1.0.3", + "pages": [ + "sdk-reference/cli/v1.0.3/auth/index", + "sdk-reference/cli/v1.0.3/sandbox/index", + "sdk-reference/cli/v1.0.3/template/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "CLI v1.0.2", + "pages": [ + "sdk-reference/cli/v1.0.2/auth/index", + "sdk-reference/cli/v1.0.2/sandbox/index", + "sdk-reference/cli/v1.0.2/template/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "CLI v1.0.1", + "pages": [ + "sdk-reference/cli/v1.0.1/auth/index", + "sdk-reference/cli/v1.0.1/sandbox/index", + "sdk-reference/cli/v1.0.1/template/index" + ] + } + ] + }, + { + "version": "v1.0.0", + "groups": [ + { + "group": "CLI v1.0.0", + "pages": [ + "sdk-reference/cli/v1.0.0/auth/index", + "sdk-reference/cli/v1.0.0/sandbox/index", + "sdk-reference/cli/v1.0.0/template/index" + ] + } + ] + } + ] + }, + { + "dropdown": "JavaScript SDK", + "icon": "square-js", + "versions": [ + { + "version": "v2.1.4@latest", + "groups": [ + { + "group": "JavaScript SDK v2.1.4", + "pages": [ + "sdk-reference/js-sdk/v2.1.4/commands/index", + "sdk-reference/js-sdk/v2.1.4/errors/index", + "sdk-reference/js-sdk/v2.1.4/filesystem/index", + "sdk-reference/js-sdk/v2.1.4/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.3", + "groups": [ + { + "group": "JavaScript SDK v2.1.3", + "pages": [ + "sdk-reference/js-sdk/v2.1.3/commands/index", + "sdk-reference/js-sdk/v2.1.3/errors/index", + "sdk-reference/js-sdk/v2.1.3/filesystem/index", + "sdk-reference/js-sdk/v2.1.3/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.2", + "groups": [ + { + "group": "JavaScript SDK v2.1.2", + "pages": [ + "sdk-reference/js-sdk/v2.1.2/commands/index", + "sdk-reference/js-sdk/v2.1.2/errors/index", + "sdk-reference/js-sdk/v2.1.2/filesystem/index", + "sdk-reference/js-sdk/v2.1.2/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.1", + "groups": [ + { + "group": "JavaScript SDK v2.1.1", + "pages": [ + "sdk-reference/js-sdk/v2.1.1/commands/index", + "sdk-reference/js-sdk/v2.1.1/errors/index", + "sdk-reference/js-sdk/v2.1.1/filesystem/index", + "sdk-reference/js-sdk/v2.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.1.0", + "groups": [ + { + "group": "JavaScript SDK v2.1.0", + "pages": [ + "sdk-reference/js-sdk/v2.1.0/commands/index", + "sdk-reference/js-sdk/v2.1.0/errors/index", + "sdk-reference/js-sdk/v2.1.0/filesystem/index", + "sdk-reference/js-sdk/v2.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.3", + "groups": [ + { + "group": "JavaScript SDK v2.0.3", + "pages": [ + "sdk-reference/js-sdk/v2.0.3/commands/index", + "sdk-reference/js-sdk/v2.0.3/errors/index", + "sdk-reference/js-sdk/v2.0.3/filesystem/index", + "sdk-reference/js-sdk/v2.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.2", + "groups": [ + { + "group": "JavaScript SDK v2.0.2", + "pages": [ + "sdk-reference/js-sdk/v2.0.2/commands/index", + "sdk-reference/js-sdk/v2.0.2/errors/index", + "sdk-reference/js-sdk/v2.0.2/filesystem/index", + "sdk-reference/js-sdk/v2.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.1", + "groups": [ + { + "group": "JavaScript SDK v2.0.1", + "pages": [ + "sdk-reference/js-sdk/v2.0.1/commands/index", + "sdk-reference/js-sdk/v2.0.1/errors/index", + "sdk-reference/js-sdk/v2.0.1/filesystem/index", + "sdk-reference/js-sdk/v2.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "JavaScript SDK v2.0.0", + "pages": [ + "sdk-reference/js-sdk/v2.0.0/commands/index", + "sdk-reference/js-sdk/v2.0.0/errors/index", + "sdk-reference/js-sdk/v2.0.0/filesystem/index", + "sdk-reference/js-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.13.2", + "groups": [ + { + "group": "JavaScript SDK v1.13.2", + "pages": [ + "sdk-reference/js-sdk/v1.13.2/commands/index", + "sdk-reference/js-sdk/v1.13.2/errors/index", + "sdk-reference/js-sdk/v1.13.2/filesystem/index", + "sdk-reference/js-sdk/v1.13.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.13.1", + "groups": [ + { + "group": "JavaScript SDK v1.13.1", + "pages": [ + "sdk-reference/js-sdk/v1.13.1/commands/index", + "sdk-reference/js-sdk/v1.13.1/errors/index", + "sdk-reference/js-sdk/v1.13.1/filesystem/index", + "sdk-reference/js-sdk/v1.13.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.13.0", + "groups": [ + { + "group": "JavaScript SDK v1.13.0", + "pages": [ + "sdk-reference/js-sdk/v1.13.0/commands/index", + "sdk-reference/js-sdk/v1.13.0/errors/index", + "sdk-reference/js-sdk/v1.13.0/filesystem/index", + "sdk-reference/js-sdk/v1.13.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.12.0", + "groups": [ + { + "group": "JavaScript SDK v1.12.0", + "pages": [ + "sdk-reference/js-sdk/v1.12.0/commands/index", + "sdk-reference/js-sdk/v1.12.0/errors/index", + "sdk-reference/js-sdk/v1.12.0/filesystem/index", + "sdk-reference/js-sdk/v1.12.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.11.0", + "groups": [ + { + "group": "JavaScript SDK v1.11.0", + "pages": [ + "sdk-reference/js-sdk/v1.11.0/commands/index", + "sdk-reference/js-sdk/v1.11.0/errors/index", + "sdk-reference/js-sdk/v1.11.0/filesystem/index", + "sdk-reference/js-sdk/v1.11.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.10.0", + "groups": [ + { + "group": "JavaScript SDK v1.10.0", + "pages": [ + "sdk-reference/js-sdk/v1.10.0/commands/index", + "sdk-reference/js-sdk/v1.10.0/errors/index", + "sdk-reference/js-sdk/v1.10.0/filesystem/index", + "sdk-reference/js-sdk/v1.10.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.1", + "groups": [ + { + "group": "JavaScript SDK v1.9.1", + "pages": [ + "sdk-reference/js-sdk/v1.9.1/commands/index", + "sdk-reference/js-sdk/v1.9.1/errors/index", + "sdk-reference/js-sdk/v1.9.1/filesystem/index", + "sdk-reference/js-sdk/v1.9.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "JavaScript SDK v1.9.0", + "pages": [ + "sdk-reference/js-sdk/v1.9.0/commands/index", + "sdk-reference/js-sdk/v1.9.0/errors/index", + "sdk-reference/js-sdk/v1.9.0/filesystem/index", + "sdk-reference/js-sdk/v1.9.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "JavaScript SDK v1.8.0", + "pages": [ + "sdk-reference/js-sdk/v1.8.0/commands/index", + "sdk-reference/js-sdk/v1.8.0/errors/index", + "sdk-reference/js-sdk/v1.8.0/filesystem/index", + "sdk-reference/js-sdk/v1.8.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "JavaScript SDK v1.7.1", + "pages": [ + "sdk-reference/js-sdk/v1.7.1/commands/index", + "sdk-reference/js-sdk/v1.7.1/errors/index", + "sdk-reference/js-sdk/v1.7.1/filesystem/index", + "sdk-reference/js-sdk/v1.7.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "JavaScript SDK v1.7.0", + "pages": [ + "sdk-reference/js-sdk/v1.7.0/commands/index", + "sdk-reference/js-sdk/v1.7.0/errors/index", + "sdk-reference/js-sdk/v1.7.0/filesystem/index", + "sdk-reference/js-sdk/v1.7.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "JavaScript SDK v1.6.0", + "pages": [ + "sdk-reference/js-sdk/v1.6.0/commands/index", + "sdk-reference/js-sdk/v1.6.0/errors/index", + "sdk-reference/js-sdk/v1.6.0/filesystem/index", + "sdk-reference/js-sdk/v1.6.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.3", + "groups": [ + { + "group": "JavaScript SDK v1.5.3", + "pages": [ + "sdk-reference/js-sdk/v1.5.3/commands/index", + "sdk-reference/js-sdk/v1.5.3/errors/index", + "sdk-reference/js-sdk/v1.5.3/filesystem/index", + "sdk-reference/js-sdk/v1.5.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "JavaScript SDK v1.5.2", + "pages": [ + "sdk-reference/js-sdk/v1.5.2/commands/index", + "sdk-reference/js-sdk/v1.5.2/errors/index", + "sdk-reference/js-sdk/v1.5.2/filesystem/index", + "sdk-reference/js-sdk/v1.5.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "JavaScript SDK v1.5.1", + "pages": [ + "sdk-reference/js-sdk/v1.5.1/commands/index", + "sdk-reference/js-sdk/v1.5.1/errors/index", + "sdk-reference/js-sdk/v1.5.1/filesystem/index", + "sdk-reference/js-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "JavaScript SDK v1.5.0", + "pages": [ + "sdk-reference/js-sdk/v1.5.0/commands/index", + "sdk-reference/js-sdk/v1.5.0/errors/index", + "sdk-reference/js-sdk/v1.5.0/filesystem/index", + "sdk-reference/js-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "JavaScript SDK v1.4.0", + "pages": [ + "sdk-reference/js-sdk/v1.4.0/commands/index", + "sdk-reference/js-sdk/v1.4.0/errors/index", + "sdk-reference/js-sdk/v1.4.0/filesystem/index", + "sdk-reference/js-sdk/v1.4.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "JavaScript SDK v1.3.0", + "pages": [ + "sdk-reference/js-sdk/v1.3.0/commands/index", + "sdk-reference/js-sdk/v1.3.0/errors/index", + "sdk-reference/js-sdk/v1.3.0/filesystem/index", + "sdk-reference/js-sdk/v1.3.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.5", + "groups": [ + { + "group": "JavaScript SDK v1.2.5", + "pages": [ + "sdk-reference/js-sdk/v1.2.5/commands/index", + "sdk-reference/js-sdk/v1.2.5/errors/index", + "sdk-reference/js-sdk/v1.2.5/filesystem/index", + "sdk-reference/js-sdk/v1.2.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.4", + "groups": [ + { + "group": "JavaScript SDK v1.2.4", + "pages": [ + "sdk-reference/js-sdk/v1.2.4/commands/index", + "sdk-reference/js-sdk/v1.2.4/errors/index", + "sdk-reference/js-sdk/v1.2.4/filesystem/index", + "sdk-reference/js-sdk/v1.2.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.3", + "groups": [ + { + "group": "JavaScript SDK v1.2.3", + "pages": [ + "sdk-reference/js-sdk/v1.2.3/commands/index", + "sdk-reference/js-sdk/v1.2.3/errors/index", + "sdk-reference/js-sdk/v1.2.3/filesystem/index", + "sdk-reference/js-sdk/v1.2.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.2", + "groups": [ + { + "group": "JavaScript SDK v1.2.2", + "pages": [ + "sdk-reference/js-sdk/v1.2.2/commands/index", + "sdk-reference/js-sdk/v1.2.2/errors/index", + "sdk-reference/js-sdk/v1.2.2/filesystem/index", + "sdk-reference/js-sdk/v1.2.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "JavaScript SDK v1.2.1", + "pages": [ + "sdk-reference/js-sdk/v1.2.1/commands/index", + "sdk-reference/js-sdk/v1.2.1/errors/index", + "sdk-reference/js-sdk/v1.2.1/filesystem/index", + "sdk-reference/js-sdk/v1.2.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "JavaScript SDK v1.2.0", + "pages": [ + "sdk-reference/js-sdk/v1.2.0/commands/index", + "sdk-reference/js-sdk/v1.2.0/errors/index", + "sdk-reference/js-sdk/v1.2.0/filesystem/index", + "sdk-reference/js-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "JavaScript SDK v1.1.1", + "pages": [ + "sdk-reference/js-sdk/v1.1.1/commands/index", + "sdk-reference/js-sdk/v1.1.1/errors/index", + "sdk-reference/js-sdk/v1.1.1/filesystem/index", + "sdk-reference/js-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "JavaScript SDK v1.1.0", + "pages": [ + "sdk-reference/js-sdk/v1.1.0/commands/index", + "sdk-reference/js-sdk/v1.1.0/errors/index", + "sdk-reference/js-sdk/v1.1.0/filesystem/index", + "sdk-reference/js-sdk/v1.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.7", + "groups": [ + { + "group": "JavaScript SDK v1.0.7", + "pages": [ + "sdk-reference/js-sdk/v1.0.7/commands/index", + "sdk-reference/js-sdk/v1.0.7/errors/index", + "sdk-reference/js-sdk/v1.0.7/filesystem/index", + "sdk-reference/js-sdk/v1.0.7/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.6", + "groups": [ + { + "group": "JavaScript SDK v1.0.6", + "pages": [ + "sdk-reference/js-sdk/v1.0.6/commands/index", + "sdk-reference/js-sdk/v1.0.6/errors/index", + "sdk-reference/js-sdk/v1.0.6/filesystem/index", + "sdk-reference/js-sdk/v1.0.6/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "JavaScript SDK v1.0.5", + "pages": [ + "sdk-reference/js-sdk/v1.0.5/commands/index", + "sdk-reference/js-sdk/v1.0.5/errors/index", + "sdk-reference/js-sdk/v1.0.5/filesystem/index", + "sdk-reference/js-sdk/v1.0.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "JavaScript SDK v1.0.4", + "pages": [ + "sdk-reference/js-sdk/v1.0.4/errors/index", + "sdk-reference/js-sdk/v1.0.4/filesystem/index", + "sdk-reference/js-sdk/v1.0.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "JavaScript SDK v1.0.3", + "pages": [ + "sdk-reference/js-sdk/v1.0.3/errors/index", + "sdk-reference/js-sdk/v1.0.3/filesystem/index", + "sdk-reference/js-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "JavaScript SDK v1.0.2", + "pages": [ + "sdk-reference/js-sdk/v1.0.2/errors/index", + "sdk-reference/js-sdk/v1.0.2/filesystem/index", + "sdk-reference/js-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "JavaScript SDK v1.0.1", + "pages": [ + "sdk-reference/js-sdk/v1.0.1/errors/index", + "sdk-reference/js-sdk/v1.0.1/filesystem/index", + "sdk-reference/js-sdk/v1.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.0", + "groups": [ + { + "group": "JavaScript SDK v1.0.0", + "pages": [ + "sdk-reference/js-sdk/v1.0.0/errors/index", + "sdk-reference/js-sdk/v1.0.0/filesystem/index", + "sdk-reference/js-sdk/v1.0.0/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Python SDK", + "icon": "python", + "versions": [ + { + "version": "v2.1.3@latest", + "groups": [ + { + "group": "Python SDK v2.1.3", + "pages": [ + "sdk-reference/python-sdk/v2.1.3/exceptions/index", + "sdk-reference/python-sdk/v2.1.3/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.1.2", + "groups": [ + { + "group": "Python SDK v2.1.2", + "pages": [ + "sdk-reference/python-sdk/v2.1.2/exceptions/index", + "sdk-reference/python-sdk/v2.1.2/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.1.1", + "groups": [ + { + "group": "Python SDK v2.1.1", + "pages": [ + "sdk-reference/python-sdk/v2.1.1/exceptions/index", + "sdk-reference/python-sdk/v2.1.1/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.1.0", + "groups": [ + { + "group": "Python SDK v2.1.0", + "pages": [ + "sdk-reference/python-sdk/v2.1.0/exceptions/index", + "sdk-reference/python-sdk/v2.1.0/sandbox_async/index", + "sdk-reference/python-sdk/v2.1.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.0.2", + "groups": [ + { + "group": "Python SDK v2.0.2", + "pages": [ + "sdk-reference/python-sdk/v2.0.2/exceptions/index", + "sdk-reference/python-sdk/v2.0.2/sandbox_async/index", + "sdk-reference/python-sdk/v2.0.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.0.1", + "groups": [ + { + "group": "Python SDK v2.0.1", + "pages": [ + "sdk-reference/python-sdk/v2.0.1/exceptions/index", + "sdk-reference/python-sdk/v2.0.1/sandbox_async/index", + "sdk-reference/python-sdk/v2.0.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "Python SDK v2.0.0", + "pages": [ + "sdk-reference/python-sdk/v2.0.0/exceptions/index", + "sdk-reference/python-sdk/v2.0.0/sandbox_async/index", + "sdk-reference/python-sdk/v2.0.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.11.1", + "groups": [ + { + "group": "Python SDK v1.11.1", + "pages": [ + "sdk-reference/python-sdk/v1.11.1/exceptions/index", + "sdk-reference/python-sdk/v1.11.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.11.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.11.0", + "groups": [ + { + "group": "Python SDK v1.11.0", + "pages": [ + "sdk-reference/python-sdk/v1.11.0/exceptions/index", + "sdk-reference/python-sdk/v1.11.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.11.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.10.0", + "groups": [ + { + "group": "Python SDK v1.10.0", + "pages": [ + "sdk-reference/python-sdk/v1.10.0/exceptions/index", + "sdk-reference/python-sdk/v1.10.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.10.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "Python SDK v1.9.0", + "pages": [ + "sdk-reference/python-sdk/v1.9.0/exceptions/index", + "sdk-reference/python-sdk/v1.9.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.9.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "Python SDK v1.8.0", + "pages": [ + "sdk-reference/python-sdk/v1.8.0/exceptions/index", + "sdk-reference/python-sdk/v1.8.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.8.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "Python SDK v1.7.1", + "pages": [ + "sdk-reference/python-sdk/v1.7.1/exceptions/index", + "sdk-reference/python-sdk/v1.7.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.7.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "Python SDK v1.7.0", + "pages": [ + "sdk-reference/python-sdk/v1.7.0/exceptions/index", + "sdk-reference/python-sdk/v1.7.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.7.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "Python SDK v1.6.0", + "pages": [ + "sdk-reference/python-sdk/v1.6.0/exceptions/index", + "sdk-reference/python-sdk/v1.6.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.6.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.6", + "groups": [ + { + "group": "Python SDK v1.5.6", + "pages": [ + "sdk-reference/python-sdk/v1.5.6/exceptions/index", + "sdk-reference/python-sdk/v1.5.6/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.6/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.5", + "groups": [ + { + "group": "Python SDK v1.5.5", + "pages": [ + "sdk-reference/python-sdk/v1.5.5/exceptions/index", + "sdk-reference/python-sdk/v1.5.5/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.5/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.4", + "groups": [ + { + "group": "Python SDK v1.5.4", + "pages": [ + "sdk-reference/python-sdk/v1.5.4/exceptions/index", + "sdk-reference/python-sdk/v1.5.4/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.4/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.3", + "groups": [ + { + "group": "Python SDK v1.5.3", + "pages": [ + "sdk-reference/python-sdk/v1.5.3/exceptions/index", + "sdk-reference/python-sdk/v1.5.3/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "Python SDK v1.5.2", + "pages": [ + "sdk-reference/python-sdk/v1.5.2/exceptions/index", + "sdk-reference/python-sdk/v1.5.2/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Python SDK v1.5.1", + "pages": [ + "sdk-reference/python-sdk/v1.5.1/exceptions/index", + "sdk-reference/python-sdk/v1.5.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Python SDK v1.5.0", + "pages": [ + "sdk-reference/python-sdk/v1.5.0/exceptions/index", + "sdk-reference/python-sdk/v1.5.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.5.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "Python SDK v1.4.0", + "pages": [ + "sdk-reference/python-sdk/v1.4.0/exceptions/index", + "sdk-reference/python-sdk/v1.4.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.4.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.5", + "groups": [ + { + "group": "Python SDK v1.3.5", + "pages": [ + "sdk-reference/python-sdk/v1.3.5/exceptions/index", + "sdk-reference/python-sdk/v1.3.5/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.5/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.4", + "groups": [ + { + "group": "Python SDK v1.3.4", + "pages": [ + "sdk-reference/python-sdk/v1.3.4/exceptions/index", + "sdk-reference/python-sdk/v1.3.4/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.4/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.3", + "groups": [ + { + "group": "Python SDK v1.3.3", + "pages": [ + "sdk-reference/python-sdk/v1.3.3/exceptions/index", + "sdk-reference/python-sdk/v1.3.3/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.2", + "groups": [ + { + "group": "Python SDK v1.3.2", + "pages": [ + "sdk-reference/python-sdk/v1.3.2/exceptions/index", + "sdk-reference/python-sdk/v1.3.2/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.1", + "groups": [ + { + "group": "Python SDK v1.3.1", + "pages": [ + "sdk-reference/python-sdk/v1.3.1/exceptions/index", + "sdk-reference/python-sdk/v1.3.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "Python SDK v1.3.0", + "pages": [ + "sdk-reference/python-sdk/v1.3.0/exceptions/index", + "sdk-reference/python-sdk/v1.3.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.3.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "Python SDK v1.2.1", + "pages": [ + "sdk-reference/python-sdk/v1.2.1/exceptions/index", + "sdk-reference/python-sdk/v1.2.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.2.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Python SDK v1.2.0", + "pages": [ + "sdk-reference/python-sdk/v1.2.0/exceptions/index", + "sdk-reference/python-sdk/v1.2.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.2.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "Python SDK v1.1.0", + "pages": [ + "sdk-reference/python-sdk/v1.1.0/exceptions/index", + "sdk-reference/python-sdk/v1.1.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.1.0/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.6", + "groups": [ + { + "group": "Python SDK v1.0.6", + "pages": [ + "sdk-reference/python-sdk/v1.0.6/exceptions/index", + "sdk-reference/python-sdk/v1.0.6/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.6/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "Python SDK v1.0.5", + "pages": [ + "sdk-reference/python-sdk/v1.0.5/exceptions/index", + "sdk-reference/python-sdk/v1.0.5/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.5/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "Python SDK v1.0.4", + "pages": [ + "sdk-reference/python-sdk/v1.0.4/exceptions/index", + "sdk-reference/python-sdk/v1.0.4/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.4/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Python SDK v1.0.3", + "pages": [ + "sdk-reference/python-sdk/v1.0.3/exceptions/index", + "sdk-reference/python-sdk/v1.0.3/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.3/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Python SDK v1.0.2", + "pages": [ + "sdk-reference/python-sdk/v1.0.2/exceptions/index", + "sdk-reference/python-sdk/v1.0.2/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.2/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Python SDK v1.0.1", + "pages": [ + "sdk-reference/python-sdk/v1.0.1/exceptions/index", + "sdk-reference/python-sdk/v1.0.1/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.1/sandbox_sync/index" + ] + } + ] + }, + { + "version": "v1.0.0", + "groups": [ + { + "group": "Python SDK v1.0.0", + "pages": [ + "sdk-reference/python-sdk/v1.0.0/exceptions/index", + "sdk-reference/python-sdk/v1.0.0/sandbox_async/index", + "sdk-reference/python-sdk/v1.0.0/sandbox_sync/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Code Interpreter JavaScript SDK", + "icon": "square-js", + "versions": [ + { + "version": "v2.0.0@latest", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v2.0.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v2.0.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.5.1", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.5.1/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.5.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.5.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.2.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.2.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.1.1", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.1.1/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.1.0", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.1.0/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "Code Interpreter JavaScript SDK v1.0.4", + "pages": [ + "sdk-reference/code-interpreter-js-sdk/v1.0.4/charts/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/consts/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/index/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/messaging/index", + "sdk-reference/code-interpreter-js-sdk/v1.0.4/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Code Interpreter Python SDK", + "icon": "python", + "versions": [ + { + "version": "v2.0.0@latest", + "groups": [ + { + "group": "Code Interpreter Python SDK v2.0.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.5.2", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.5.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.5.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.5.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.2.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.2.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.2.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.1.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.0", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.1.0", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.1.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.5", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.5", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.4", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.4", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.3", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.2", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Code Interpreter Python SDK v1.0.1", + "pages": [ + "sdk-reference/code-interpreter-python-sdk/v1.0.1/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Desktop JavaScript SDK", + "icon": "square-js", + "versions": [ + { + "version": "v2.0.1@latest", + "groups": [ + { + "group": "Desktop JavaScript SDK v2.0.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v2.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v2.0.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.9.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.9.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.9.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.9.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.9.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.9.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.9.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.8.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.8.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.8.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.8.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.8.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.8.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.3", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.3", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.7.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.7.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.6.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.6.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.6.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.6.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.6.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.6.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.5.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.4.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.4.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.3.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.3.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.2.0", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.1.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.0.3", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.0.2", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Desktop JavaScript SDK v1.0.1", + "pages": [ + "sdk-reference/desktop-js-sdk/v1.0.1/sandbox/index" + ] + } + ] + } + ] + }, + { + "dropdown": "Desktop Python SDK", + "icon": "python", + "versions": [ + { + "version": "v2.0.1@latest", + "groups": [ + { + "group": "Desktop Python SDK v2.0.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v2.0.1/sandbox/index" + ] + } + ] + }, + { + "version": "v2.0.0", + "groups": [ + { + "group": "Desktop Python SDK v2.0.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v2.0.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.4", + "groups": [ + { + "group": "Desktop Python SDK v1.7.4", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.3", + "groups": [ + { + "group": "Desktop Python SDK v1.7.3", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.2", + "groups": [ + { + "group": "Desktop Python SDK v1.7.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.1", + "groups": [ + { + "group": "Desktop Python SDK v1.7.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.7.0", + "groups": [ + { + "group": "Desktop Python SDK v1.7.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.7.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.5", + "groups": [ + { + "group": "Desktop Python SDK v1.6.5", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.5/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.4", + "groups": [ + { + "group": "Desktop Python SDK v1.6.4", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.4/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.3", + "groups": [ + { + "group": "Desktop Python SDK v1.6.3", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.2", + "groups": [ + { + "group": "Desktop Python SDK v1.6.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.1", + "groups": [ + { + "group": "Desktop Python SDK v1.6.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.6.0", + "groups": [ + { + "group": "Desktop Python SDK v1.6.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.6.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.2", + "groups": [ + { + "group": "Desktop Python SDK v1.5.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.5.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.1", + "groups": [ + { + "group": "Desktop Python SDK v1.5.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.5.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.5.0", + "groups": [ + { + "group": "Desktop Python SDK v1.5.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.5.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.4.0", + "groups": [ + { + "group": "Desktop Python SDK v1.4.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.4.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.3.0", + "groups": [ + { + "group": "Desktop Python SDK v1.3.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.3.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.2.0", + "groups": [ + { + "group": "Desktop Python SDK v1.2.0", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.2.0/sandbox/index" + ] + } + ] + }, + { + "version": "v1.1.1", + "groups": [ + { + "group": "Desktop Python SDK v1.1.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.1.1/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.3", + "groups": [ + { + "group": "Desktop Python SDK v1.0.3", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.0.3/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.2", + "groups": [ + { + "group": "Desktop Python SDK v1.0.2", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.0.2/sandbox/index" + ] + } + ] + }, + { + "version": "v1.0.1", + "groups": [ + { + "group": "Desktop Python SDK v1.0.1", + "pages": [ + "sdk-reference/desktop-python-sdk/v1.0.1/sandbox/index" + ] + } + ] + } + ] + } +] \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/snippets/CodeInterpreting.jsx b/apps/web/src/app/(docs)/mintlify-docs/snippets/CodeInterpreting.jsx new file mode 100644 index 0000000000..2ab1571d73 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/snippets/CodeInterpreting.jsx @@ -0,0 +1,37 @@ +export const CodeInterpreting = () => { + const items = [ + { + href: "/code-interpreting/analyze-data-with-ai", + title: "Analyze data with AI", + description: "Learn how to use E2B run AI-generated code to analyze yourdata.", + icon: "file-circle-question", + }, + { + href: "/code-interpreting/create-charts-visualizations", + title: "Create charts & visualizations", + description: "Create interactive charts by running Python code in E2B.", + icon: "chart-waterfall", + }, + // { + // href: '/code-interpreting/connect-your-data', + // title: 'Connect your data', + // description: 'TODO: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ut purus eget sapien. Sed ut purus eget sapien.', + // icon: , + // }, + // { + // href: '/code-interpreting/todo', + // title: 'Parsing code execution results', + // description: 'TODO: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ut purus eget sapien. Sed ut purus eget sapien.', + // icon: , + // }, + ]; + return ( + + {items.map((i) => ( + + {i.description} + + ))} + + ); +}; diff --git a/apps/web/src/app/(docs)/mintlify-docs/snippets/Concepts.jsx b/apps/web/src/app/(docs)/mintlify-docs/snippets/Concepts.jsx new file mode 100644 index 0000000000..daf838363a --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/snippets/Concepts.jsx @@ -0,0 +1,43 @@ +export const Concepts = () => { + const concepts = [ + { + href: "/sandbox", + title: "Sandbox lifecycle", + description: "Learn about how to start the sandbox, manage its lifecycle, and interact with it.", + icon: "hourglass", + }, + { + href: "/sandbox/persistence", + title: "Sandbox persistence", + description: "Learn how to achieve data persistence by pausing and resuming sandboxes.", + icon: "rotate-reverse", + }, + // { + // href: '/code-execution', + // title: 'AI code execution', + // description: 'E2B Sandboxex offer built-in support for running AI-generated Python, JS, TS, and R. You can customize sandbox to run almost any language.', + // icon: , + // }, + { + href: "/filesystem", + title: "Filesystem", + description: "Sandbox has an isolated filesystem that you can use to create, read, write, and delete files.", + icon: "folder-tree", + }, + { + href: "/commands", + title: "Commands", + description: "Run terminal commands inside the Sandbox and start any process inside the Sandbox.", + icon: "terminal", + }, + ]; + return ( + + {concepts.map((i) => ( + + {i.description} + + ))} + + ); +}; diff --git a/apps/web/src/app/(docs)/mintlify-docs/snippets/Quickstart.jsx b/apps/web/src/app/(docs)/mintlify-docs/snippets/Quickstart.jsx new file mode 100644 index 0000000000..dd1a7208de --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/snippets/Quickstart.jsx @@ -0,0 +1,37 @@ +export const Quickstart = () => { + const items = [ + { + href: "/quickstart", + title: "Running your first Sandbox", + description: "Learn how to start your first E2B Sandbox with our Python or JavaScript SDK.", + icon: "circle-play", + }, + { + href: "/quickstart/connect-llms", + title: "Connecting LLMs to E2B", + description: "Connect your favorite LLM to E2B to run AI-generated code inside the Sandbox.", + icon: "brain-circuit", + }, + { + href: "/quickstart/upload-download-files", + title: "Uploading & downloading files", + description: "A quick guide on how to upload and download files to and from the Sandbox.", + icon: "cloud-arrow-up", + }, + { + href: "/quickstart/install-custom-packages", + title: "Install custom packages", + description: "Customize your Sandbox with third-party packages.", + icon: "box-open-full", + }, + ]; + return ( + + {items.map((i) => ( + + {i.description} + + ))} + + ); +}; diff --git a/apps/web/src/app/(docs)/mintlify-docs/snippets/SandboxSpec.mdx b/apps/web/src/app/(docs)/mintlify-docs/snippets/SandboxSpec.mdx new file mode 100644 index 0000000000..1cd59fbec2 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/snippets/SandboxSpec.mdx @@ -0,0 +1,125 @@ +### CPU + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    vCPUsPlanCosts
    1Pro$0.000014/s
    + 2 [default] + Hobby / Pro$0.000028/s
    3Pro$0.000042/s
    4Pro$0.000056/s
    5Pro$0.000070/s
    6Pro$0.000084/s
    7Pro$0.000098/s
    8Pro$0.000112/s
    +
    + +### RAM + +
    + + + + + + + + + + + + + + + + + + + + + + +
    RAMPlanCosts
    + 512 MiB [default] + Hobby / Pro$0.0000045/GiB/s
    + even value between 128 MiB and 8,192 MiB + Pro$0.0000045/GiB/s
    +
    + +### Storage + +
    + + + + + + + + + + + + + + + + + + + + + + +
    StoragePlanCosts
    1 GiBHobbyFree
    5 GiBProFree
    +
    diff --git a/apps/web/src/app/(docs)/mintlify-docs/style.css b/apps/web/src/app/(docs)/mintlify-docs/style.css new file mode 100644 index 0000000000..470feb3087 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/style.css @@ -0,0 +1,28 @@ +#topbar-links { + background-color: var(--background-white); +} + +/* Add styles specifically for the Sign In link */ +a[href*="auth/sign-in"].whitespace-nowrap.font-medium { + background-color: black; + color: white !important; + padding: 0.5rem 1rem; + border-radius: 4px; + transition: background-color 0.2s ease; +} + +a[href*="auth/sign-in"].whitespace-nowrap.font-medium:hover { + background-color: #333; + color: white !important; +} + +/* Dark mode styles */ +.dark a[href*="auth/sign-in"].whitespace-nowrap.font-medium { + background-color: white; + color: black !important; +} + +.dark a[href*="auth/sign-in"].whitespace-nowrap.font-medium:hover { + background-color: #f3f3f3; + color: black !important; +} diff --git a/apps/web/src/app/(docs)/mintlify-docs/support/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/support/index.mdx new file mode 100644 index 0000000000..3a10aa1d77 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/support/index.mdx @@ -0,0 +1,24 @@ +--- +title: "Need help?" +icon: "messages" +--- + +Join our Discord community, open GitHub issues, or send us an email if you have any questions or request. + + + + + + diff --git a/apps/web/src/app/(docs)/mintlify-docs/troubleshooting/sdks/workers-edge-runtime/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/troubleshooting/sdks/workers-edge-runtime/index.mdx new file mode 100644 index 0000000000..57a4516b63 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/troubleshooting/sdks/workers-edge-runtime/index.mdx @@ -0,0 +1,5 @@ +--- +title: "Vercel Edge Runtime and Cloudflare Workers" +--- + +The E2B JavaScript SDK currently lacks support for Vercel Edge Runtime and Cloudflare Workers due to transport layer package incompatibility used for Sandbox communication. We recommend using supported runtimes like Node, Bun, or Deno instead. diff --git a/apps/web/src/app/(docs)/mintlify-docs/troubleshooting/templates/build-authentication-error/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/troubleshooting/templates/build-authentication-error/index.mdx new file mode 100644 index 0000000000..2457276a55 --- /dev/null +++ b/apps/web/src/app/(docs)/mintlify-docs/troubleshooting/templates/build-authentication-error/index.mdx @@ -0,0 +1,73 @@ +--- +title: "Docker push authentication error" +sidebarTitle: Build authentication error +--- + +When the CLI tries to push a Docker image to the registry, you might encounter an authentication error. This error sometimes occurs for users when Docker doesn't send any credentials to the registry. +To resolve this issue, you can use the following steps: + +## MacOS + +1. Open Docker Desktop. +2. Go to Settings. +3. Go to Docker Engine. +4. Add the following line to the json configuration: + +```json +{ + "insecure-registries": ["host.docker.internal:49984"] +} +``` + +It may look like this: + +```json +{ + "builder": { + "gc": { + "defaultKeepStorage": "20GB", + "enabled": true + } + }, + "features": { + "buildkit": true + }, + "insecure-registries": [ + "host.docker.internal:49984" + ] +} +``` +This allows Docker to send requests to local proxy, which handles the authentication. + +5. Click Apply & Restart. + + +## Linux + +1. Edit the Docker configuration file (usually `/etc/docker/daemon.json`) and add the following line, if the file doesn't exist, create it: +```json +{ + "insecure-registries": ["localhost:49984"] +} +``` + +2. Restart Docker: + +```bash +sudo systemctl restart docker +``` + +## Windows + +1. Open Docker Desktop. +2. Go to Settings. +3. Go to Docker Engine. +4. Add the following line to the json configuration: + +```json +{ + "insecure-registries": ["host.docker.internal:49984"] +} +``` +5. Click Apply & Restart. + From f951e1c3da383169471dac2fd47caa64753fea30 Mon Sep 17 00:00:00 2001 From: gabrielraeder Date: Tue, 30 Sep 2025 11:23:58 -0300 Subject: [PATCH 2/4] updates from feedback file --- .../src/app/(docs)/mintlify-docs/_mint.json | 130 ------------------ .../analyze-data-with-ai/index.mdx | 122 ++++++++-------- .../code-interpreting/streaming/index.mdx | 25 ++-- .../commands/background/index.mdx | 2 +- .../src/app/(docs)/mintlify-docs/docs.json | 10 -- .../src/app/(docs)/mintlify-docs/favicon.svg | 49 ------- .../mintlify-docs/filesystem/watch/index.mdx | 32 ++--- .../legacy/guide/custom-sandbox/index.mdx | 8 +- .../legacy/sandbox/api/cwd/index.mdx | 44 +++--- .../legacy/sandbox/api/debugging/index.mdx | 14 +- .../legacy/sandbox/api/download/index.mdx | 12 +- .../legacy/sandbox/api/envs/index.mdx | 16 +-- .../legacy/sandbox/api/filesystem/index.mdx | 67 +++++---- .../legacy/sandbox/api/metadata/index.mdx | 8 +- .../legacy/sandbox/api/process/index.mdx | 60 ++++---- .../legacy/sandbox/api/reconnect/index.mdx | 16 +-- .../legacy/sandbox/api/timeouts/index.mdx | 32 ++--- .../legacy/sandbox/api/upload/index.mdx | 12 +- .../legacy/sandbox/api/url/index.mdx | 16 +-- .../sandbox/templates/overview/index.mdx | 8 +- .../(docs)/mintlify-docs/quickstart/index.mdx | 6 +- .../mintlify-docs/sandbox-template/index.mdx | 14 +- .../sandbox-template/ready-cmd/index.mdx | 4 +- .../sandbox-template/start-cmd/index.mdx | 4 +- .../mintlify-docs/sandbox/connect/index.mdx | 18 ++- .../sandbox/environment-variables/index.mdx | 36 ++--- .../(docs)/mintlify-docs/sandbox/index.mdx | 8 +- .../sandbox/internet-access/index.mdx | 8 +- .../mintlify-docs/sandbox/list/index.mdx | 82 +++++------ .../mintlify-docs/sandbox/metadata/index.mdx | 4 +- .../mintlify-docs/sandbox/metrics/index.mdx | 12 +- .../sandbox/persistence/index.mdx | 32 ++--- .../src/app/(docs)/mintlify-docs/style.css | 14 +- 33 files changed, 370 insertions(+), 555 deletions(-) delete mode 100644 apps/web/src/app/(docs)/mintlify-docs/_mint.json delete mode 100644 apps/web/src/app/(docs)/mintlify-docs/favicon.svg diff --git a/apps/web/src/app/(docs)/mintlify-docs/_mint.json b/apps/web/src/app/(docs)/mintlify-docs/_mint.json deleted file mode 100644 index 407ced733c..0000000000 --- a/apps/web/src/app/(docs)/mintlify-docs/_mint.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "$schema": "https://mintlify.com/schema.json", - "name": "E2B Docs", - "logo": { - "dark": "/logo/white.svg", - "light": "/logo/white.svg" - }, - "favicon": "/favicon.jpeg", - "colors": { - "primary": "#ff8800", - "light": "#ff8800", - "dark": "#ffffff", - "anchors": { - "from": "#ff8800", - "to": "#ff8800" - }, - "background": { - "dark": "#000000", - "light": "#ffffff" - } - }, - "modeToggle": { - "default": "dark" - }, - "rounded": "sharp", - "topbarLinks": [ - { - "name": "SIGN IN", - "url": "https://e2b.dev/auth/sign-in?redirect_to=https%3A%2F%2Fe2b.dev%2Fdocs" - } - ], - "topbarCtaButton": { - "type": "github", - "url": "https://github.com/e2b-dev/e2b" - }, - "primaryTab": { - "name": "Docs" - }, - "tabs": [ - { - "name": "SDK Reference", - "url": "sdk" - } - ], - "anchors": [ - { - "name": "Documentation", - "icon": "book-open-cover", - "url": "https://e2b.dev/docs" - }, - { - "name": "Dashboard", - "icon": "house", - "url": "https://e2b.dev/dashboard" - } - ], - "navigation": [ - { - "group": "Get Started", - "pages": [ - "introduction", - { - "group": "Quickstart", - "pages": [ - "quickstart/get-started", - "quickstart/connect" - ] - } - ] - }, - { - "group": "Sandbox", - "pages": [ - "sandbox/lifestyle" - ] - }, - { - "group": "CLI", - "pages": [ - { - "group": "Auth", - "pages": [ - "sdk/cli/auth" - ] - }, - { - "group": "Sandbox", - "pages": [ - "sdk/sandbox/sandbox" - ] - } - ] - }, - { - "group": "JavaScript SDK", - "icon": "js", - "pages": [ - { - "group": "Commands", - "icon": "js", - "pages": [ - "sdk/javascript/commands/cmd" - ] - }, - { - "group": "Errors", - "icon": "js", - "pages": [ - "sdk/javascript/errors/auth" - ] - } - ] - } - ], - "font": { - "headings": { - "family": "IBM Plex Mono", - "weight": 700 - }, - "body": { - "family": "IBM Plex Mono", - "weight": 400 - } - }, - "footerSocials": { - "x": "https://x.com/mintlify", - "github": "https://github.com/mintlify", - "linkedin": "https://linkedin.com/company/mintlify" - } -} diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx index a0f65c2f1a..5fa78aea50 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/analyze-data-with-ai/index.mdx @@ -187,49 +187,49 @@ The way we'll do it is by connecting the method for running AI-generated code we Update the initialization of the Anthropic client to include the tool use like this: -```js index.ts +```js index.ts highlight={6-20} const msg = await anthropic.messages.create({ model: 'claude-3-5-sonnet-20240620', max_tokens: 1024, messages: [{ role: 'user', content: prompt }], - tools: [ // $HighlightLine - { // $HighlightLine - name: 'run_python_code', // $HighlightLine - description: 'Run Python code', // $HighlightLine - input_schema: { // $HighlightLine - type: 'object', // $HighlightLine - properties: { // $HighlightLine - code: { // $HighlightLine - type: 'string', // $HighlightLine - description: 'The Python code to run', // $HighlightLine - }, // $HighlightLine - }, // $HighlightLine - required: ['code'], // $HighlightLine - }, // $HighlightLine - }, // $HighlightLine - ], // $HighlightLine + tools: [ + { + name: 'run_python_code', + description: 'Run Python code', + input_schema: { + type: 'object', + properties: { + code: { + type: 'string', + description: 'The Python code to run', + }, + }, + required: ['code'], + }, + }, + ], }) ``` -```python main.py +```python main.py highlight={7-19} msg = anthropic.messages.create( model='claude-3-5-sonnet-20240620', max_tokens=1024, messages=[ {"role": "user", "content": prompt} ], - tools=[ # $HighlightLine - { # $HighlightLine - "name": "run_python_code", # $HighlightLine - "description": "Run Python code", # $HighlightLine - "input_schema": { # $HighlightLine - "type": "object", # $HighlightLine - "properties": { # $HighlightLine - "code": { "type": "string", "description": "The Python code to run" }, # $HighlightLine - }, # $HighlightLine - "required": ["code"], # $HighlightLine - }, # $HighlightLine - }, # $HighlightLine - ], # $HighlightLine + tools=[ + { + "name": "run_python_code", + "description": "Run Python code", + "input_schema": { + "type": "object", + "properties": { + "code": { "type": "string", "description": "The Python code to run" }, + }, + "required": ["code"], + }, + }, + ], ) ``` @@ -276,58 +276,58 @@ In this example we're specifically asking for a chart so we'll be looking for th Let's update the `runAIGeneratedCode` method in JavaScript and `run_ai_generated_code` method in Python to check for the chart in the results and save it to the file. -```js index.ts +```js index.ts highlight={7-12,17-25} async function runAIGeneratedCode(aiGeneratedCode: string) { console.log('Running the code in the sandbox....') const execution = await sbx.runCode(aiGeneratedCode) console.log('Code execution finished!') // First let's check if the code ran successfully. - if (execution.error) { // $HighlightLine - console.error('AI-generated code had an error.') // $HighlightLine - console.log(execution.error.name) // $HighlightLine - console.log(execution.error.value) // $HighlightLine - console.log(execution.error.traceback) // $HighlightLine - process.exit(1) // $HighlightLine - } // $HighlightLine + if (execution.error) { + console.error('AI-generated code had an error.') + console.log(execution.error.name) + console.log(execution.error.value) + console.log(execution.error.traceback) + process.exit(1) + } // Iterate over all the results and specifically check for png files that will represent the chart. - let resultIdx = 0 // $HighlightLine - for (const result of execution.results) { // $HighlightLine - if (result.png) { // $HighlightLine + let resultIdx = 0 + for (const result of execution.results) { + if (result.png) { // Save the png to a file // The png is in base64 format. - fs.writeFileSync(`chart-${resultIdx}.png`, result.png, { encoding: 'base64' }) // $HighlightLine - console.log(`Chart saved to chart-${resultIdx}.png`) // $HighlightLine - resultIdx++ // $HighlightLine - } // $HighlightLine - } // $HighlightLine + fs.writeFileSync(`chart-${resultIdx}.png`, result.png, { encoding: 'base64' }) + console.log(`Chart saved to chart-${resultIdx}.png`) + resultIdx++ + } + } } ``` -```python main.py +```python main.py highlight={7-12,15-23} def run_ai_generated_code(ai_generated_code: str): print('Running the code in the sandbox....') execution = sbx.run_code(ai_generated_code) print('Code execution finished!') # First let's check if the code ran successfully. - if execution.error: # $HighlightLine - print('AI-generated code had an error.') # $HighlightLine - print(execution.error.name) # $HighlightLine - print(execution.error.value) # $HighlightLine - print(execution.error.traceback) # $HighlightLine - sys.exit(1) # $HighlightLine + if execution.error: + print('AI-generated code had an error.') + print(execution.error.name) + print(execution.error.value) + print(execution.error.traceback) + sys.exit(1) # Iterate over all the results and specifically check for png files that will represent the chart. - result_idx = 0 # $HighlightLine - for result in execution.results: # $HighlightLine - if result.png: # $HighlightLine + result_idx = 0 + for result in execution.results: + if result.png: # Save the png to a file # The png is in base64 format. - with open(f'chart-{result_idx}.png', 'wb') as f: # $HighlightLine - f.write(base64.b64decode(result.png)) # $HighlightLine - print(f'Chart saved to chart-{result_idx}.png') # $HighlightLine - result_idx += 1 # $HighlightLine + with open(f'chart-{result_idx}.png', 'wb') as f: + f.write(base64.b64decode(result.png)) + print(f'Chart saved to chart-{result_idx}.png') + result_idx += 1 ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx index a426246df0..7120f9401f 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/code-interpreting/streaming/index.mdx @@ -9,7 +9,7 @@ Use E2B SDK allows you to stream the output, and results when executing code in When using the `runCode()` method in JavaScript or `run_code()` in Python you can pass `onStdout`/`on_stdout` and `onStderr`/`on_stderr` callbacks to handle the output. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={15-17} import { Sandbox } from '@e2b/code-interpreter' const codeToRun = ` @@ -24,12 +24,12 @@ const codeToRun = ` const sandbox = await Sandbox.create() sandbox.runCode(codeToRun, { // Use `onError` to handle runtime code errors - onError: error => console.error('error:', error), // $HighlightLine - onStdout: data => console.log('stdout:', data), // $HighlightLine - onStderr: data => console.error('stderr:', data), // $HighlightLine + onError: error => console.error('error:', error), + onStdout: data => console.log('stdout:', data), + onStderr: data => console.error('stderr:', data), }) ``` -```python Python +```python Python highlight={17-19} from e2b_code_interpreter import Sandbox code_to_run = """ @@ -46,9 +46,9 @@ sandbox = Sandbox.create() sandbox.run_code( code_to_run, # Use `on_error` to handle runtime code errors - on_error=lambda error: print('error:', error), # $HighlightLine - on_stdout=lambda data: print('stdout:', data), # $HighlightLine - on_stderr=lambda data: print('stderr:', data), # $HighlightLine + on_error=lambda error: print('error:', error), + on_stdout=lambda data: print('stdout:', data), + on_stderr=lambda data: print('stderr:', data), ) ``` @@ -79,7 +79,6 @@ stdout: This goes first to stdout stderr: This goes later to stderr stdout: This goes last - ``` @@ -89,7 +88,7 @@ When using the `runCode()` method in JavaScript or `run_code()` in Python you ca to receive results from the sandbox like charts, tables, text, and more. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={20} const codeToRun = ` import matplotlib.pyplot as plt @@ -109,10 +108,10 @@ plt.show() ` const sandbox = await Sandbox.create() await sandbox.runCode(codeToRun, { - onResult: result => console.log('result:', result), // $HighlightLine + onResult: result => console.log('result:', result), }) ``` -```python Python +```python Python highlight={24} from e2b_code_interpreter import Sandbox code_to_run = """ @@ -136,7 +135,7 @@ plt.show() sandbox = Sandbox.create() sandbox.run_code( code_to_run, - on_result=lambda result: print('result:', result), # $HighlightLine + on_result=lambda result: print('result:', result), ) ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx index 857ea91337..abaf810642 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/commands/background/index.mdx @@ -14,7 +14,7 @@ const sandbox = await Sandbox.create() // Start the command in the background const command = await sandbox.commands.run('echo hello; sleep 10; echo world', { - background: true, // $HighlightLine + background: true, onStdout: (data) => { console.log(data) }, diff --git a/apps/web/src/app/(docs)/mintlify-docs/docs.json b/apps/web/src/app/(docs)/mintlify-docs/docs.json index afe812021b..5164b229a3 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/docs.json +++ b/apps/web/src/app/(docs)/mintlify-docs/docs.json @@ -2598,15 +2598,5 @@ "github": "https://github.com/mintlify", "linkedin": "https://linkedin.com/company/mintlify" } - }, - "fonts": { - "heading": { - "family": "IBM Plex Mono", - "weight": 700 - }, - "body": { - "family": "IBM Plex Mono", - "weight": 400 - } } } \ No newline at end of file diff --git a/apps/web/src/app/(docs)/mintlify-docs/favicon.svg b/apps/web/src/app/(docs)/mintlify-docs/favicon.svg deleted file mode 100644 index 6a3233265c..0000000000 --- a/apps/web/src/app/(docs)/mintlify-docs/favicon.svg +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx index e64a5bc887..a20ac30b26 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/filesystem/watch/index.mdx @@ -18,12 +18,12 @@ const sandbox = await Sandbox.create() const dirname = '/home/user' // Start watching directory for changes -const handle = await sandbox.files.watchDir(dirname, async (event) => { // $HighlightLine - console.log(event) // $HighlightLine - if (event.type === FilesystemEventType.WRITE) { // $HighlightLine - console.log(`wrote to file ${event.name}`) // $HighlightLine - } // $HighlightLine -}) // $HighlightLine +const handle = await sandbox.files.watchDir(dirname, async (event) => { + console.log(event) + if (event.type === FilesystemEventType.WRITE) { + console.log(`wrote to file ${event.name}`) + } +}) // Trigger file write event await sandbox.files.write(`${dirname}/my-file`, 'hello') @@ -35,16 +35,16 @@ sandbox = Sandbox.create() dirname = '/home/user' # Watch directory for changes -handle = sandbox.files.watch_dir(dirname) # $HighlightLine +handle = sandbox.files.watch_dir(dirname) # Trigger file write event sandbox.files.write(f"{dirname}/my-file", "hello") # Retrieve the latest new events since the last `get_new_events()` call -events = handle.get_new_events() # $HighlightLine -for event in events: # $HighlightLine - print(event) # $HighlightLine - if event.type == FilesystemEventType.Write: # $HighlightLine - print(f"wrote to file {event.name}") # $HighlightLine +events = handle.get_new_events() +for event in events: + print(event) + if event.type == FilesystemEventType.Write: + print(f"wrote to file {event.name}") ``` @@ -71,11 +71,11 @@ const handle = await sandbox.files.watchDir(dirname, async (event) => { console.log(`wrote to file ${event.name}`) } }, { - recursive: true // $HighlightLine + recursive: true }) // Trigger file write event -await sandbox.files.write(`${dirname}/my-folder/my-file`, 'hello') // $HighlightLine +await sandbox.files.write(`${dirname}/my-folder/my-file`, 'hello') ``` ```python Python highlight={7,9} from e2b_code_interpreter import Sandbox @@ -84,9 +84,9 @@ sandbox = Sandbox.create() dirname = '/home/user' # Watch directory for changes -handle = sandbox.files.watch_dir(dirname, recursive=True) # $HighlightLine +handle = sandbox.files.watch_dir(dirname, recursive=True) # Trigger file write event -sandbox.files.write(f"{dirname}/my-folder/my-file", "hello") # $HighlightLine +sandbox.files.write(f"{dirname}/my-folder/my-file", "hello") # Retrieve the latest new events since the last `get_new_events()` call events = handle.get_new_events() diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx index eb342414ec..7bec79aae8 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/guide/custom-sandbox/index.mdx @@ -171,11 +171,11 @@ This way, we'll be able to spawn our custom sandbox and control it with the SDK. ##### Spawn & control your custom sandbox -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={4} import { Sandbox } from 'e2b' // Spawn your custom sandbox -const sandbox = await Sandbox.create({ template: 'my-agent-sandbox' }) // $HighlightLine +const sandbox = await Sandbox.create({ template: 'my-agent-sandbox' }) // Interact with sandbox. Learn more here: // https://e2b.dev/docs/sandbox/overview @@ -184,11 +184,11 @@ const sandbox = await Sandbox.create({ template: 'my-agent-sandbox' }) // $Highl await sandbox.close() ``` -```python Python +```python Python highlight={4} from e2b import Sandbox # Spawn your custom sandbox -sandbox = Sandbox.create(template="my-agent-sandbox") # $HighlightLine +sandbox = Sandbox.create(template="my-agent-sandbox") # Interact with sandbox. Learn more here: # https://e2b.dev/docs/sandbox/overview diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx index f15ece5fae..b7bbdb1d33 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/cwd/index.mdx @@ -12,29 +12,29 @@ You can set a working directory either for the whole sandbox, a filesystem opera If the current working directory for the sandbox is not set, it will default to the home directory - `/home/user`. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5-9} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', - cwd: '/code', // $HighlightLine + cwd: '/code', }) // You can also change the cwd of an existing sandbox -sandbox.cwd = '/home' // $HighlightLine +sandbox.cwd = '/home' await sandbox.close() ``` -```python Python +```python Python highlight={5-9} from e2b import Sandbox sandbox = Sandbox( template="base", - cwd="/code", # $HighlightLine + cwd="/code", ) # You can also change the cwd of an existing sandbox -sandbox.cwd = "/home" # $HighlightLine +sandbox.cwd = "/home" sandbox.close() ``` @@ -45,15 +45,15 @@ sandbox.close() All filesystem operations with relative paths are relative to the current working directory. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5,8,16} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', - cwd: '/home/user/code', // $HighlightLine + cwd: '/home/user/code', }) -await sandbox.filesystem.write('hello.txt', 'Welcome to E2B!') // $HighlightLine +await sandbox.filesystem.write('hello.txt', 'Welcome to E2B!') const proc = await sandbox.process.start({ cmd: 'cat /home/user/code/hello.txt', }) @@ -61,7 +61,7 @@ await proc.wait() console.log(proc.output.stdout) // output: "Welcome to E2B!" -await sandbox.filesystem.write('../hello.txt', 'We hope you have a great day!') // $HighlightLine +await sandbox.filesystem.write('../hello.txt', 'We hope you have a great day!') const proc2 = await sandbox.process.start({cmd: 'cat /home/user/hello.txt'}) await proc2.wait() console.log(proc2.output.stdout) @@ -69,20 +69,20 @@ console.log(proc2.output.stdout) await sandbox.close() ``` -```python Python +```python Python highlight={5,7,13} from e2b import Sandbox sandbox = Sandbox( template="base", - cwd="/home/user/code" # $HighlightLine + cwd="/home/user/code" ) -sandbox.filesystem.write("hello.txt", "Welcome to E2B!") # $HighlightLine +sandbox.filesystem.write("hello.txt", "Welcome to E2B!") proc = sandbox.process.start("cat /home/user/code/hello.txt") proc.wait() print(proc.output.stdout) # output: "Welcome to E2B!" -sandbox.filesystem.write("../hello.txt", "We hope you have a great day!") # $HighlightLine +sandbox.filesystem.write("../hello.txt", "We hope you have a great day!") proc2 = sandbox.process.start("cat /home/user/hello.txt") proc2.wait() print(proc2.output.stdout) @@ -97,36 +97,36 @@ sandbox.close() If you set a working directory for the sandbox, all processes will inherit it. You can override it for each process. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5,8,13} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', - cwd: '/code', // $HighlightLine + cwd: '/code', }) -const sandboxCwd = await sandbox.process.start({cmd: 'pwd'}) // $HighlightLine +const sandboxCwd = await sandbox.process.start({cmd: 'pwd'}) await sandboxCwd.wait() console.log(sandboxCwd.output.stdout) // output: /code -const processCwd = await sandbox.process.start({cmd: 'pwd', cwd: '/home'}) // $HighlightLine +const processCwd = await sandbox.process.start({cmd: 'pwd', cwd: '/home'}) await processCwd.wait() console.log(processCwd.output.stdout) // output: /home await sandbox.close() ``` -```python Python +```python Python highlight={3,4,9} from e2b import Sandbox -sandbox = Sandbox(template="base", cwd="/code") # $HighlightLine -sandbox_cwd = sandbox.process.start("pwd") # $HighlightLine +sandbox = Sandbox(template="base", cwd="/code") +sandbox_cwd = sandbox.process.start("pwd") sandbox_cwd.wait() print(sandbox_cwd.output.stdout) # output: "/code" -process_cwd = sandbox.process.start("pwd", cwd="/home") # $HighlightLine +process_cwd = sandbox.process.start("pwd", cwd="/home") process_cwd.wait() print(process_cwd.output.stdout) # output: "/home" diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx index 5667e30bd1..d11a3212bd 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/debugging/index.mdx @@ -19,7 +19,7 @@ export const sections = [ -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={14} import { Sandbox } from 'e2b' const logger = { @@ -33,10 +33,10 @@ const logger = { const sandbox = await Sandbox.create({ template: 'base', apiKey: process.env.E2B_API_KEY, - logger, // $HighlightLine + logger, }) ``` -```python Python +```python Python highlight={10,15,18,29} import logging from os import getenv @@ -46,15 +46,15 @@ E2B_API_KEY = getenv("E2B_API_KEY") # Global logging configuration logging.basicConfig(level=logging.INFO, format="GLOBAL - [%(asctime)s] - %(name)-32s - %(levelname)7s: %(message)s", - datefmt="%Y-%m-%d %H:%M:%S") # $HighlightLine + datefmt="%Y-%m-%d %H:%M:%S") # Or configure only e2b logger # Get e2b logger -e2b_logger = logging.getLogger("e2b") # $HighlightLine +e2b_logger = logging.getLogger("e2b") # Set e2b logger level to INFO -e2b_logger.setLevel(logging.INFO) # $HighlightLine +e2b_logger.setLevel(logging.INFO) # Setup formatter formatter = logging.Formatter("E2B - [%(asctime)s] - %(name)-32s - %(levelname)7s: %(message)s", @@ -65,7 +65,7 @@ handler = logging.StreamHandler() handler.setFormatter(formatter) # Add handler to e2b logger -e2b_logger.addHandler(handler) # $HighlightLine +e2b_logger.addHandler(handler) def main(): diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx index 0b21871167..2855834030 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/download/index.mdx @@ -12,27 +12,27 @@ For example, the download file method is useful for downloading any files produc This LLM-generated code might produce some files like charts, CSV files, or PDF files that you want to download to your machine. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from 'e2b' import fs from 'node:fs' const sandbox = await Sandbox.create({ template: 'base' }) -const buffer = await sandbox.downloadFile('path/to/remote/file/inside/sandbox', 'buffer') // $HighlightLine +const buffer = await sandbox.downloadFile('path/to/remote/file/inside/sandbox', 'buffer') // Save file to local filesystem fs.writeFileSync('path/to/local/file', buffer) await sandbox.close() ``` -```python Python +```python Python highlight={5,7,8} from e2b import Sandbox sandbox = Sandbox(template="base") -file_in_bytes = sandbox.download_file("path/to/remote/file/inside/sandbox") # $HighlightLine +file_in_bytes = sandbox.download_file("path/to/remote/file/inside/sandbox") # Save file to local filesystem -with open("path/to/local/file", "wb") as f: # $HighlightLine - f.write(file_in_bytes) # $HighlightLine +with open("path/to/local/file", "wb") as f: + f.write(file_in_bytes) sandbox.close() ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx index 29fae5dfc7..f3b7fdf0b9 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/envs/index.mdx @@ -8,22 +8,22 @@ title: "Setting environment variables" ## Global environment variables You can set the sandbox's global environment variables when initializing a new sandbox. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', - envVars: {FOO: 'Hello'}, // $HighlightLine + envVars: {FOO: 'Hello'}, }) await sandbox.close() ``` -```python Python +```python Python highlight={5} from e2b import Sandbox sandbox = Sandbox( template="base", - env_vars={"FOO": "Hello"}, # $HighlightLine + env_vars={"FOO": "Hello"}, ) sandbox.close() @@ -39,7 +39,7 @@ Environment variables set when starting a new process have precedence over the e -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={10} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ @@ -49,7 +49,7 @@ const sandbox = await Sandbox.create({ const proc = await sandbox.process.start({ cmd: 'echo $FOO $BAR!', - envVars: {BAR: 'World'}, // $HighlightLine + envVars: {BAR: 'World'}, }) await proc.wait() console.log(proc.output.stdout) @@ -57,7 +57,7 @@ console.log(proc.output.stdout) await sandbox.close() ``` -```python Python +```python Python highlight={10} from e2b import Sandbox sandbox = Sandbox( @@ -67,7 +67,7 @@ sandbox = Sandbox( proc = sandbox.process.start( "echo $FOO $BAR!", - env_vars={"BAR": "World"}, # $HighlightLine + env_vars={"BAR": "World"}, ) proc.wait() diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx index 71fe1e3c27..a972478a45 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/filesystem/index.mdx @@ -6,27 +6,27 @@ title: List directory -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={7} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', }) -const dirContent = await sandbox.filesystem.list('/') // $HighlightLine +const dirContent = await sandbox.filesystem.list('/') dirContent.forEach((item) => { console.log(item.name) }) await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox sandbox = Sandbox(template="base") # List the root directory -content = sandbox.filesystem.list("/") # $HighlightLine +content = sandbox.filesystem.list("/") for item in content: print(f"Is '{item.name}' directory?", item.is_dir) @@ -39,23 +39,23 @@ sandbox.close() Create directory and all parent directories. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) // Create a new directory '/dir' -await sandbox.filesystem.makeDir('/dir') // $HighlightLine +await sandbox.filesystem.makeDir('/dir') await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox sandbox = Sandbox(template="base") # Create a new directory '/dir' -sandbox.filesystem.make_dir("/dir") # $HighlightLine +sandbox.filesystem.make_dir("/dir") sandbox.close() ``` @@ -70,7 +70,7 @@ When writing to a file that already exists, the file will get overwritten. When writing to a file that's in a directory that doesn't exist, you'll get an error. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={11} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) @@ -81,14 +81,14 @@ const sandbox = await Sandbox.create({ template: 'base' }) // - overwrite the file if it exists // Write the content of the file '/hello.txt' -await sandbox.filesystem.write('/hello.txt', 'Hello World!') // $HighlightLine +await sandbox.filesystem.write('/hello.txt', 'Hello World!') // The following would fail because '/dir' doesn't exist // await sandbox.filesystem.write("/dir/hello.txt", "Hello World!") await sandbox.close() ``` -```python Python +```python Python highlight={11} from e2b import Sandbox sandbox = Sandbox(template="base") @@ -99,7 +99,7 @@ sandbox = Sandbox(template="base") # - overwrite the file if it exists # Write the content of the file '/hello.txt' -sandbox.filesystem.write("/hello.txt", "Hello World!") # $HighlightLine +sandbox.filesystem.write("/hello.txt", "Hello World!") # The following would fail because '/dir' doesn't exist # sandbox.filesystem.write("/dir/hello.txt", "Hello World!") @@ -111,23 +111,23 @@ sandbox.close() ## Read from file -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) -const fileContent = await sandbox.filesystem.read('/etc/hosts') // $HighlightLine +const fileContent = await sandbox.filesystem.read('/etc/hosts') console.log(fileContent) await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox sandbox = Sandbox(template="base") # Read the '/etc/hosts' file -file_content = sandbox.filesystem.read("/etc/hosts") # $HighlightLine +file_content = sandbox.filesystem.read("/etc/hosts") # Prints something like: # 127.0.0.1 localhost @@ -140,7 +140,7 @@ sandbox.close() ## Write bytes -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={10} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) @@ -150,7 +150,7 @@ const encoder = new TextEncoder('utf-8') const contentInBytes = encoder.encode('Hello World!') // `writeBytes` accepts a Uint8Array and saves it to a file inside the playground -await sandbox.filesystem.writeBytes('/file', contentInBytes) // $HighlightLine +await sandbox.filesystem.writeBytes('/file', contentInBytes) // We can read the file back to verify the content const fileContent = await sandbox.filesystem.read('/file') @@ -160,7 +160,7 @@ console.log(fileContent) await sandbox.close() ``` -```python Python +```python Python highlight={8} from e2b import Sandbox sandbox = Sandbox(template="base") @@ -168,7 +168,7 @@ sandbox = Sandbox(template="base") content_in_bytes = bytearray(b"Hello world") # `write_bytes` will write bytearray to a file inside the playground. -sandbox.filesystem.write_bytes("/file", content_in_bytes) # $HighlightLine +sandbox.filesystem.write_bytes("/file", content_in_bytes) # We can read the file back to verify the content file_content = sandbox.filesystem.read("/file") @@ -181,7 +181,7 @@ sandbox.close() ## Read bytes -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={8} import fs from 'fs' import { Sandbox } from 'e2b' @@ -189,7 +189,7 @@ const sandbox = await Sandbox.create({ template: 'base' }) // File bytes will read file's content as bytes // `fileBytes` as a Uint8Array -const fileBytes = await sandbox.filesystem.readBytes('/etc/hosts') // $HighlightLine +const fileBytes = await sandbox.filesystem.readBytes('/etc/hosts') // The output will look similar to this: // -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6-10} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) // Start filesystem watcher for the /home directory -const watcher = sandbox.filesystem.watchDir('/home') // $HighlightLine -watcher.addEventListener((event) => { - // $HighlightLine - console.log('Filesystem event', event) // $HighlightLine -}) // $HighlightLine -await watcher.start() // $HighlightLine +const watcher = sandbox.filesystem.watchDir('/home') +watcher.addEventListener((event) => { + console.log('Filesystem event', event) +}) +await watcher.start() // Create files in the /home directory inside the playground // We'll receive notifications for these events through the watcher we created above. @@ -249,14 +248,14 @@ for (let i = 0; i < 10; i++) { await sandbox.close() ``` -```python Python +```python Python highlight={7,19} import time from e2b import Sandbox sandbox = Sandbox.create() -watcher = sandbox.files.watch_dir("/home") # $HighlightLine +watcher = sandbox.files.watch_dir("/home") # Create files in the /home directory inside the playground # We'll receive notifications for these events through the watcher we created above. @@ -268,7 +267,7 @@ for i in range(10): time.sleep(1) for event in watcher.get(): - print(f"Event: {event.type} {event.name}") # $HighlightLine + print(f"Event: {event.type} {event.name}") watcher.stop() sandbox.kill() diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx index 49855db1c0..96233b4433 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/metadata/index.mdx @@ -8,12 +8,12 @@ title: Sandbox metadata You can assign metadata to your sandbox. This metadata will be available if you call `Sandbox.list()`. This can be useful in a situation where each of your users have dedicated sandbox and the time between the steps of the integration is long. You can use the metadata to store the user id and reconnect to it later. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', - metadata: { userID: 'uniqueID' } // $HighlightLine + metadata: { userID: 'uniqueID' } }) // Keep the sandbox alive for 60 seconds await sandbox.keepAlive(60_000) @@ -34,13 +34,13 @@ if (found) { await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox, SandboxState from e2b.sandbox.sandbox_api import SandboxQuery sandbox = Sandbox( template="base", - metadata={"user_id": "uniqueID"}, # $HighlightLine + metadata={"user_id": "uniqueID"}, ) # Keep the sandbox alive for 60 seconds diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx index 5662be01f7..ce3c6bfe94 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/process/index.mdx @@ -17,13 +17,13 @@ Here are the basic operations you can do with the process inside the sandbox: ## Start process -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) const npmInit = await sandbox.process.start({ - cmd: 'npm init -y', // $HighlightLine + cmd: 'npm init -y', }) await npmInit.wait() @@ -31,12 +31,12 @@ console.log(npmInit.output.stdout) await sandbox.close() ``` -```python Python +```python Python highlight={5} from e2b import Sandbox sandbox = Sandbox(template="base") -npm_init = sandbox.process.start("npm init -y") # $HighlightLine +npm_init = sandbox.process.start("npm init -y") npm_init.wait() print(npm_init.stdout) @@ -47,7 +47,7 @@ sandbox.close() ## Stop process -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={10} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ @@ -57,19 +57,19 @@ const sandbox = await Sandbox.create({ const npmInit = await sandbox.process.start({ cmd: 'npm init -y', }) -await npmInit.kill() // $HighlightLine +await npmInit.kill() // There will be no output because we immediately kill the `npm_init` process console.log(npmInit.output.stdout) await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox sandbox = Sandbox(template="base") npm_init = sandbox.process.start("npm init -y") -npm_init.kill() # $HighlightLine +npm_init.kill() # There will be no output because we immediately kill the `npm_init` process print(npm_init.stdout) @@ -83,12 +83,12 @@ sandbox.close() Set either stdout handler for the whole sandbox level or per process. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5,16} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', - onStdout: (output) => console.log('sandbox', output.line), // $HighlightLine + onStdout: (output) => console.log('sandbox', output.line), }) const proc = await sandbox.process.start({ @@ -99,19 +99,19 @@ await proc.wait() const procWithCustomHandler = await sandbox.process.start({ cmd: 'echo "Hello World!"', - onStdout: (data) => console.log('process', data.line), // $HighlightLine + onStdout: (data) => console.log('process', data.line), }) await procWithCustomHandler.wait() // output: process Hello World! await sandbox.close() ``` -```python Python +```python Python highlight={5,14} from e2b import Sandbox sandbox = Sandbox( template="base", - on_stdout=lambda output: print("sandbox", output.line), # $HighlightLine + on_stdout=lambda output: print("sandbox", output.line), ) proc = sandbox.process.start('echo "Hello World!"') @@ -120,7 +120,7 @@ proc.wait() proc_with_custom_handler = sandbox.process.start( 'echo "Hello World!"', - on_stdout=lambda output: print("process", output.line), # $HighlightLine + on_stdout=lambda output: print("process", output.line), ) proc_with_custom_handler.wait() # output: process Hello World! @@ -134,7 +134,7 @@ sandbox.close() Set either stderr handler for the whole sandbox level or per process. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={10,17} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ @@ -144,26 +144,26 @@ const sandbox = await Sandbox.create({ // This command will fail and output to stderr because Golang isn't installed in the cloud playground const golangVersion = await sandbox.process.start({ cmd: 'go version', - onStderr: (output) => console.log('sandbox', output.line), // $HighlightLine + onStderr: (output) => console.log('sandbox', output.line), }) await golangVersion.wait() // output: [sandbox] /bin/bash: line 1: go: command not found const procWithCustomHandler = await sandbox.process.start({ cmd: 'go version', - onStderr: (data) => console.log('process', data.line), // $HighlightLine + onStderr: (data) => console.log('process', data.line), }) await procWithCustomHandler.wait() // output: process /bin/bash: line 1: go: command not found await sandbox.close() ``` -```python Python +```python Python highlight={5,15} from e2b import Sandbox sandbox = Sandbox( template="base", - on_stderr=lambda output: print("[sandbox]", output.line), # $HighlightLine + on_stderr=lambda output: print("[sandbox]", output.line), ) # This command will fail and output to stderr because Golang isn't installed in the cloud playground @@ -173,7 +173,7 @@ proc.wait() proc_with_custom_handler = sandbox.process.start( "go version", - on_stderr=lambda output: print("[process]", output.line), # $HighlightLine + on_stderr=lambda output: print("[process]", output.line), ) proc_with_custom_handler.wait() # output: [process] /bin/bash: line 1: go: command not found @@ -187,12 +187,12 @@ sandbox.close() Set either on exit handler for the whole sandbox level or per process. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5,14} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base', - onExit: () => console.log('[sandbox]', 'process ended'), // $HighlightLine + onExit: () => console.log('[sandbox]', 'process ended'), }) const proc = await sandbox.process.start({cmd: 'echo "Hello World!"'}) @@ -201,19 +201,19 @@ await proc.wait() const procWithCustomHandler = await sandbox.process.start({ cmd: 'echo "Hello World!"', - onExit: () => console.log('[process]', 'process ended'), // $HighlightLine + onExit: () => console.log('[process]', 'process ended'), }) await procWithCustomHandler.wait() // output: [process] process ended await sandbox.close() ``` -```python Python +```python Python highlight={5,14} from e2b import Sandbox sandbox = Sandbox( template="base", - on_exit=lambda: print("[sandbox]", "process ended"), # $HighlightLine + on_exit=lambda: print("[sandbox]", "process ended"), ) proc = sandbox.process.start('echo "Hello World!"') @@ -222,7 +222,7 @@ proc.wait() proc_with_custom_handler = sandbox.process.start( 'echo "Hello World!"', - on_exit=lambda: print("[process]", "process ended"), # $HighlightLine + on_exit=lambda: print("[process]", "process ended"), ) proc_with_custom_handler.wait() # output: [process] process ended @@ -234,7 +234,7 @@ sandbox.close() ## Send stdin -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={11} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) @@ -245,12 +245,12 @@ const proc = await sandbox.process.start({ cmd: 'while IFS= read -r line; do echo "$line"; sleep 1; done', onStdout: (output) => console.log(output), }) -await proc.sendStdin('AI Playground\n') // $HighlightLine +await proc.sendStdin('AI Playground\n') await proc.kill() await sandbox.close() ``` -```python Python +```python Python highlight={11} from e2b import Sandbox sandbox = Sandbox(template="base") @@ -261,7 +261,7 @@ proc = sandbox.process.start( 'while IFS= read -r line; do echo "$line"; sleep 1; done', on_stdout=print, ) -proc.send_stdin("AI Playground\n") # $HighlightLine +proc.send_stdin("AI Playground\n") proc.kill() sandbox.close() diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx index d217450ed4..aab0ea6658 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/reconnect/index.mdx @@ -45,7 +45,7 @@ Call the `keep_alive`/`keepAlive` method on the sandbox instance to keep it aliv You then disconnect from the sandbox. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={8} // Do something in the sandbox await sandbox.filesystem.write('hello.txt', 'Hello World!') @@ -53,7 +53,7 @@ await sandbox.filesystem.write('hello.txt', 'Hello World!') const sandboxID = sandbox.id // Keep alive the sandbox for 2 minutes -await sandbox.keepAlive(2 * 60 * 1000) // 2 minutes $HighlightLine +await sandbox.keepAlive(2 * 60 * 1000) // 2 minutes // Close the sandbox. Even if we close the sandbox, it will stay alive, because we explicitly called keepAlive(). await sandbox.close() @@ -61,7 +61,7 @@ await sandbox.close() // Do something else... await wait(60 * 1000) ``` -```python Python +```python Python highlight={8} # Do something in the sandbox sandbox.filesystem.write('hello.txt', 'Hello World!') @@ -69,7 +69,7 @@ sandbox.filesystem.write('hello.txt', 'Hello World!') sandboxID = sandbox.id # Keep the sandbox alive for 2 minutes -sandbox.keep_alive(60 * 2) # $HighlightLine +sandbox.keep_alive(60 * 2) # Close the sandbox. Even if we close the sandbox, it will stay alive, because we explicitly called keep_alive(). sandbox.close() @@ -82,9 +82,9 @@ time.sleep(60) You can then reconnect to the sandbox from anywhere. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={2} // Reconnect to the sandbox -const sandbox2 = await Sandbox.reconnect(sandboxID) // $HighlightLine +const sandbox2 = await Sandbox.reconnect(sandboxID) // Continue in using the sandbox const content = await sandbox2.filesystem.read('hello.txt') @@ -93,9 +93,9 @@ console.log(content) // Close the sandbox await sandbox2.close() ``` -```python Python +```python Python highlight={2} # Reconnect to the sandbox -sandbox2 = Sandbox.reconnect(sandboxID) # $HighlightLine +sandbox2 = Sandbox.reconnect(sandboxID) # Continue in using the sandbox content = sandbox2.filesystem.read('hello.txt') diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx index bbcd06b020..40e08d7a3c 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/timeouts/index.mdx @@ -9,22 +9,22 @@ The SDK has a number of timeouts that can be configured to control how long the ## Timeout creating sandbox -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from 'e2b' // Timeout 3s for the sandbox to open const sandbox = await Sandbox.create({ template: 'base', - timeout: 3000, // $HighlightLine + timeout: 3000, }) await sandbox.close() ``` -```python Python +```python Python highlight={4} from e2b import Sandbox # Timeout 3s for the sandbox to open -sandbox = Sandbox(template="base", timeout=3) # $HighlightLine +sandbox = Sandbox(template="base", timeout=3) sandbox.close() ``` @@ -32,7 +32,7 @@ sandbox.close() ## Timeout process -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={8} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) @@ -40,19 +40,19 @@ const sandbox = await Sandbox.create({ template: 'base' }) // Timeout 3s for the process to start const npmInit = await sandbox.process.start({ cmd: 'npm init -y', - timeout: 3000, // $HighlightLine + timeout: 3000, }) await npmInit.wait() await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox sandbox = Sandbox(template="base") # Timeout 3s for the process to start -npm_init = sandbox.process.start("npm init -y", timeout=3) # $HighlightLine +npm_init = sandbox.process.start("npm init -y", timeout=3) npm_init.wait() sandbox.close() @@ -61,38 +61,38 @@ sandbox.close() ## Timeout filesystem operations -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6,9,13} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) // Timeout 3s for the write operation -await sandbox.filesystem.write('hello.txt', 'Hello World!', {timeout: 3000}) // $HighlightLine +await sandbox.filesystem.write('hello.txt', 'Hello World!', {timeout: 3000}) // Timeout 3s for the list operation -const files = await sandbox.filesystem.list('.', {timeout: 3000}) // $HighlightLine +const files = await sandbox.filesystem.list('.', {timeout: 3000}) console.log(files) // Timeout 3s for the read operation -const content = await sandbox.filesystem.read('hello.txt', {timeout: 3000}) // $HighlightLine +const content = await sandbox.filesystem.read('hello.txt', {timeout: 3000}) console.log(content) await sandbox.close() ``` -```python Python +```python Python highlight={6,9,13} from e2b import Sandbox sandbox = Sandbox(template="base") # Timeout 3s for the write operation -sandbox.filesystem.write("test.txt", "Hello World", timeout=3) # $HighlightLine +sandbox.filesystem.write("test.txt", "Hello World", timeout=3) # Timeout 3s for the list operation -dir_content = sandbox.filesystem.list(".", timeout=3) # $HighlightLine +dir_content = sandbox.filesystem.list(".", timeout=3) print(dir_content) # Timeout 3s for the read operation -file_content = sandbox.filesystem.read("test.txt", timeout=3) # $HighlightLine +file_content = sandbox.filesystem.read("test.txt", timeout=3) print(file_content) sandbox.close() diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx index e3f5021da7..517417c175 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/upload/index.mdx @@ -15,16 +15,16 @@ We support uploading files up to 100MB at the moment. If you need to upload larg -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={7-9} import { Sandbox } from 'e2b' import fs from 'node:fs' const sandbox = await Sandbox.create({ template: 'base' }) // If you're in the server environment -const filename = 'data.csv' // $HighlightLine -const fileBuffer = fs.readFileSync('path/to/local/file') // $HighlightLine -const remotePath = await sandbox.uploadFile(fileBuffer, filename) // $HighlightLine +const filename = 'data.csv' +const fileBuffer = fs.readFileSync('path/to/local/file') +const remotePath = await sandbox.uploadFile(fileBuffer, filename) // If you're in the browser environment, you can use the Blob API // const filename = 'data.csv' @@ -42,13 +42,13 @@ console.log( await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox sandbox = Sandbox(template="base") with open("path/to/local/file", "rb") as f: - remote_path = sandbox.upload_file(f) # $HighlightLine + remote_path = sandbox.upload_file(f) sandbox.close() ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx index b835e16a04..423d3005b1 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/api/url/index.mdx @@ -10,22 +10,22 @@ Each sandbox has its own URL that you can use to connect to any service running For example, you can start a server inside the sandbox and connect to it from your browser. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={5} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) -const url = sandbox.getHostname() // $HighlightLine +const url = sandbox.getHostname() console.log('https://' + url) await sandbox.close() ``` -```python Python +```python Python highlight={5} from e2b import Sandbox sandbox = Sandbox(template="base") -url = sandbox.get_host() # $HighlightLine +url = sandbox.get_host() print("https://" + url) sandbox.close() @@ -35,24 +35,24 @@ sandbox.close() If you want to get an URL for a specific port inside the sandbox, pass the port number to the `getHostname()`/`get_hostname()` method. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from 'e2b' const sandbox = await Sandbox.create({ template: 'base' }) const openPort = 3000 -const url = sandbox.getHostname(openPort) // $HighlightLine +const url = sandbox.getHostname(openPort) console.log('https://' + url) await sandbox.close() ``` -```python Python +```python Python highlight={6} from e2b import Sandbox sandbox = Sandbox(template="base") open_port = 3000 -url = sandbox.get_host(open_port) # $HighlightLine +url = sandbox.get_host(open_port) print("https://" + url) sandbox.close() diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx index 81521cc10c..d850f027ba 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/sandbox/templates/overview/index.mdx @@ -29,26 +29,26 @@ Follow our [guide](/legacy/guide/custom-sandbox) on how to create a custom sandb ``` 1. Pass the template ID to our SDK like this: - ```js JavaScript & TypeScript + ```js JavaScript & TypeScript highlight={6} import { Sandbox } from 'e2b' // Create new sandbox const sandbox = await Sandbox.create({ // You get sandbox template from the CLI after you run `$ e2b template build` - template: '', // $HighlightLine + template: '', }) // Close sandbox once done await sandbox.close() ``` - ```python Python + ```python Python highlight={6} from e2b import Sandbox # Create new sandbox sandbox = Sandbox.create( # You get sandbox template from the CLI after you run `$ e2b template build` - template="", # $HighlightLine + template="", ) # Close sandbox once done diff --git a/apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx index 60a264429e..9890edc285 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/quickstart/index.mdx @@ -30,7 +30,8 @@ pip install e2b-code-interpreter python-dotenv We'll write the minimal code for starting Sandbox, executing Python inside it and listing all files inside the root directory. -```javascript index.ts +```javascript JavaScript & TypeScript +// index.ts import 'dotenv/config' import { Sandbox } from '@e2b/code-interpreter' @@ -41,7 +42,8 @@ console.log(execution.logs) const files = await sbx.files.list('/') console.log(files) ``` -```python main.py +```python Python +# main.py from dotenv import load_dotenv load_dotenv() from e2b_code_interpreter import Sandbox diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx index 1da2ce4ec3..5ceff2375b 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/index.mdx @@ -49,12 +49,12 @@ The following command will create a basic `e2b.Dockerfile` in the current direct ### 3. Customize `e2b.Dockerfile` Now you can customize your sandbox template by editing the `e2b.Dockerfile` file. - ```bash e2b.Dockerfile + ```bash e2b.Dockerfile highlight={2,5} # Make sure to use this base image - FROM e2bdev/code-interpreter:latest # $HighlightLine + FROM e2bdev/code-interpreter:latest # Install some Python packages - RUN pip install cowsay # $HighlightLine + RUN pip install cowsay ``` @@ -84,9 +84,9 @@ Now you can use the template ID to create a sandbox with the SDK. import { Sandbox } from '@e2b/code-interpreter' // Your template ID from the previous step - const templateID = 'id-of-your-template' // $HighlightLine + const templateID = 'id-of-your-template' // Pass the template ID to the `Sandbox.create` method - const sandbox = await Sandbox.create(templateID) // $HighlightLine + const sandbox = await Sandbox.create(templateID) // The template installed cowsay, so we can use it const execution = await sandbox.runCode(` @@ -100,9 +100,9 @@ Now you can use the template ID to create a sandbox with the SDK. from e2b_code_interpreter import Sandbox # Your template ID from the previous step - template_id = 'id-of-your-template' # $HighlightLine + template_id = 'id-of-your-template' # Pass the template ID to the `Sandbox.create` method - sandbox = Sandbox.create(template_id) # $HighlightLine + sandbox = Sandbox.create(template_id) # The template installed cowsay, so we can use it execution = sandbox.run_code(""" diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx index 6d4b89b7ab..4d5b4c54ae 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/ready-cmd/index.mdx @@ -19,12 +19,12 @@ e2b template build --ready-cmd "" ### Sandbox template config You can specify the ready command inside the `e2b.toml` in the same directory where you run `e2b template build`. - ```toml + ```toml e2b.toml highlight={5} # This is a config for E2B sandbox template template_id = "1wdqsf9le9gk21ztb4mo" dockerfile = "e2b.Dockerfile" template_name = "my-agent-sandbox" - ready_cmd = "" # $HighlightLine + ready_cmd = "" ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx index fd7893f692..ea85d5faf9 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox-template/start-cmd/index.mdx @@ -23,12 +23,12 @@ When you spawn the custom sandbox you built, the start command will be already r ### Sandbox template config You can specify the start command also inside the `e2b.toml` in the same directory where you run `e2b template build`. - ```toml highlight={5} + ```toml e2b.toml highlight={5} # This is a config for E2B sandbox template template_id = "1wdqsf9le9gk21ztb4mo" dockerfile = "e2b.Dockerfile" template_name = "my-agent-sandbox" - start_cmd = "" # $HighlightLine + start_cmd = "" ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx index 48705f9c26..d2bd054294 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/connect/index.mdx @@ -10,13 +10,13 @@ This is useful if you want to, for example, reuse the same sandbox instance for To connect to a running sandbox, you first need to retrieve its ID. You can do this by calling the `Sandbox.list()` method. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from '@e2b/code-interpreter' const sbx = await Sandbox.create() // Get all running sandboxes const paginator = await Sandbox.list({ - query: { state: ['running'] }, // $HighlightLine + query: { state: ['running'] }, }) const runningSandboxes = await paginator.nextItems() @@ -28,11 +28,11 @@ if (runningSandboxes.length === 0) { const sandboxId = runningSandboxes[0].sandboxId ``` -```python Python +```python Python highlight={4} from e2b_code_interpreter import Sandbox # Get all running sandboxes -paginator = Sandbox.list() # $HighlightLine +paginator = Sandbox.list() # Get the ID of the sandbox you want to connect to running_sandboxes = paginator.next_items() @@ -50,7 +50,7 @@ sandbox_id = running_sandboxes[0].sandbox_id Now that you have the sandbox ID, you can connect to the sandbox using the `Sandbox.connect()` method. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={14} import { Sandbox } from "@e2b/code-interpreter" // Get all running sandboxes @@ -64,12 +64,11 @@ if (runningSandboxes.length === 0) { const sandboxId = runningSandboxes[0].sandboxId // Connect to the sandbox -const sandbox = await Sandbox.connect(sandboxId) // $HighlightLine +const sandbox = await Sandbox.connect(sandboxId) // Now you can use the sandbox as usual // ... - ``` -```python Python +```python Python highlight={13} from e2b_code_interpreter import Sandbox # Get all running sandboxes @@ -82,9 +81,8 @@ if len(running_sandboxes) == 0: sandbox_id = running_sandboxes[0].sandbox_id # Connect to the sandbox -sandbox = Sandbox.connect(sandbox_id) # $HighlightLine +sandbox = Sandbox.connect(sandbox_id) # Now you can use the sandbox as usual # ... - ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx index 8c6b0c9f62..3f91b1a5d3 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/environment-variables/index.mdx @@ -50,18 +50,18 @@ You can set global environment variables when creating a sandbox. import { Sandbox } from '@e2b/code-interpreter' const sandbox = await Sandbox.create({ - envs: { // $HighlightLine - MY_VAR: 'my_value', // $HighlightLine - }, // $HighlightLine + envs: { + MY_VAR: 'my_value', + }, }) ``` ```python Python highlight={4-6} from e2b_code_interpreter import Sandbox sandbox = Sandbox.create( - envs={ # $HighlightLine - 'MY_VAR': 'my_value', # $HighlightLine - }, # $HighlightLine + envs={ + 'MY_VAR': 'my_value', + }, ) ``` @@ -78,18 +78,18 @@ You can set environment variables for specific code execution call in the sandbo ```js JavaScript & TypeScript highlight={3-5} const sandbox = await Sandbox.create() const result = await sandbox.runCode('import os; print(os.environ.get("MY_VAR"))', { - envs: { // $HighlightLine - MY_VAR: 'my_value', // $HighlightLine - }, // $HighlightLine + envs: { + MY_VAR: 'my_value', + }, }) ``` ```python Python highlight={4-6} sandbox = Sandbox.create() result = sandbox.run_code( 'import os; print(os.environ.get("MY_VAR"))', - envs={ # $HighlightLine - 'MY_VAR': 'my_value' # $HighlightLine - } # $HighlightLine + envs={ + 'MY_VAR': 'my_value' + } ) ``` @@ -106,18 +106,18 @@ You can set environment variables for specific command execution in the sandbox. ```js JavaScript & TypeScript highlight={3-5} const sandbox = await Sandbox.create() sandbox.commands.run('echo $MY_VAR', { - envs: { // $HighlightLine - MY_VAR: '123', // $HighlightLine - }, // $HighlightLine + envs: { + MY_VAR: '123', + }, }) ``` ```python Python highlight={4-6} sandbox = Sandbox.create() sandbox.commands.run( 'echo $MY_VAR', - envs={ # $HighlightLine - 'MY_VAR': '123' # $HighlightLine - } # $HighlightLine + envs={ + 'MY_VAR': '123' + } ) ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx index 3e5bd29692..5b25f8a3ac 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/index.mdx @@ -6,22 +6,22 @@ sidebarTitle: Lifecycle When you start the sandbox, it stays alive for 5 minutes by default but you can change it by passing the `timeout` parameter. After the time passes, the sandbox will be automatically shutdown. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from '@e2b/code-interpreter' // Create sandbox with and keep it running for 60 seconds. // 🚨 Note: The units are milliseconds. const sandbox = await Sandbox.create({ - timeoutMs: 60_000, // $HighlightLine + timeoutMs: 60_000, }) ``` -```python Python +```python Python highlight={6} from e2b_code_interpreter import Sandbox # Create sandbox with and keep it running for 60 seconds. # 🚨 Note: The units are seconds. sandbox = Sandbox.create( - timeout=60, # $HighlightLine + timeout=60, ) ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx index 691ae65484..d9ebaddd10 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/internet-access/index.mdx @@ -35,22 +35,22 @@ When internet access is disabled, the sandbox cannot make outbound network conne Every sandbox has a public URL that can be used to access running services inside the sandbox. -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={6} import { Sandbox } from '@e2b/code-interpreter' const sandbox = await Sandbox.create() // You need to always pass a port number to get the host -const host = sandbox.getHost(3000) // $HighlightLine +const host = sandbox.getHost(3000) console.log(`https://${host}`) ``` -```python Python +```python Python highlight={6} from e2b_code_interpreter import Sandbox sandbox = Sandbox.create() # You need to always pass a port number to get the host -host = sandbox.get_host(3000) # $HighlightLine +host = sandbox.get_host(3000) print(f'https://{host}') ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx index 80092d771b..aa49e531a1 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/list/index.mdx @@ -19,15 +19,15 @@ The `Sandbox.list()` method supports pagination. In the [advanced pagination](/s const sandbox = await Sandbox.create( { metadata: { - name: 'My Sandbox', // $HighlightLine + name: 'My Sandbox', }, }, ) - const paginator = Sandbox.list() // $HighlightLine + const paginator = Sandbox.list() // Get the first page of sandboxes (running and paused) - const firstPage = await paginator.nextItems() // $HighlightLine + const firstPage = await paginator.nextItems() const runningSandbox = firstPage[0] @@ -37,21 +37,21 @@ The `Sandbox.list()` method supports pagination. In the [advanced pagination](/s console.log('Running sandbox template id:', runningSandbox.templateId) // Get the next page of sandboxes - const nextPage = await paginator.nextItems() // $HighlightLine + const nextPage = await paginator.nextItems() ``` ```python Python highlight={5,9,12,22} from e2b_code_interpreter import Sandbox, SandboxInfo sandbox = Sandbox.create( metadata={ - "name": "My Sandbox", # $HighlightLine + "name": "My Sandbox", }, ) - paginator = Sandbox.list() # $HighlightLine + paginator = Sandbox.list() # Get the first page of sandboxes (running and paused) - firstPage = paginator.next_items() # $HighlightLine + firstPage = paginator.next_items() running_sandbox = firstPage[0] @@ -61,7 +61,7 @@ The `Sandbox.list()` method supports pagination. In the [advanced pagination](/s print('Running sandbox template id:', running_sandbox.template_id) # Get the next page of sandboxes - nextPage = paginator.next_items() # $HighlightLine + nextPage = paginator.next_items() ``` The code above will output something like this: @@ -95,11 +95,11 @@ Filter sandboxes by their current state. The state parameter can contain either // List sandboxes that are running or paused. const paginator = Sandbox.list({ query: { - state: ['running', 'paused'], // $HighlightLine + state: ['running', 'paused'], }, }) - const sandboxes = await paginator.nextItems() // $HighlightLine + const sandboxes = await paginator.nextItems() ``` ```python Python highlight={9,14} from e2b_code_interpreter import Sandbox, SandboxQuery, SandboxState @@ -110,12 +110,12 @@ Filter sandboxes by their current state. The state parameter can contain either # List sandboxes that are running or paused. paginator = Sandbox.list( query=SandboxQuery( - state=[SandboxState.RUNNING, SandboxState.PAUSED], # $HighlightLine + state=[SandboxState.RUNNING, SandboxState.PAUSED], ), ) # Get the first page of sandboxes (running and paused) - sandboxes = paginator.next_items() # $HighlightLine + sandboxes = paginator.next_items() ``` @@ -128,20 +128,20 @@ Filter sandboxes by the metadata key value pairs specified during Sandbox creati // Create sandbox with metadata. const sandbox = await Sandbox.create({ metadata: { - env: 'dev', // $HighlightLine - app: 'my-app', // $HighlightLine - userId: '123', // $HighlightLine + env: 'dev', + app: 'my-app', + userId: '123', }, }) // List all sandboxes that has `userId` key with value `123` and `env` key with value `dev`. const paginator = Sandbox.list({ query: { - metadata: { userId: '123', env: 'dev' }, // $HighlightLine + metadata: { userId: '123', env: 'dev' }, }, }) - const sandboxes = await paginator.nextItems() // $HighlightLine + const sandboxes = await paginator.nextItems() ``` ```python Python highlight={6-8,16-17} from e2b_code_interpreter import Sandbox, SandboxQuery, SandboxState @@ -149,9 +149,9 @@ Filter sandboxes by the metadata key value pairs specified during Sandbox creati # Create sandbox with metadata. sandbox = Sandbox.create( metadata={ - "env": "dev", # $HighlightLine - "app": "my-app", # $HighlightLine - "user_id": "123", # $HighlightLine + "env": "dev", + "app": "my-app", + "user_id": "123", }, ) @@ -159,8 +159,8 @@ Filter sandboxes by the metadata key value pairs specified during Sandbox creati paginator = Sandbox.list( query=SandboxQuery( metadata={ - "userId": "123", # $HighlightLine - "env": "dev", # $HighlightLine + "userId": "123", + "env": "dev", } ), ) @@ -179,8 +179,8 @@ For more granular pagination, you can set custom per-page item limit (default an import { Sandbox } from '@e2b/code-interpreter' const paginator = Sandbox.list({ - limit: 100, // $HighlightLine - nextToken: '', // $HighlightLine + limit: 100, + nextToken: '', }) // Additional paginator properties @@ -191,22 +191,22 @@ For more granular pagination, you can set custom per-page item limit (default an paginator.nextToken // Fetch the next page - await paginator.nextItems() // $HighlightLine + await paginator.nextItems() ``` ```python Python highlight={5-6,13} from e2b_code_interpreter import Sandbox # List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`. paginator = Sandbox.list( - limit=100, # $HighlightLine - next_token="", # $HighlightLine + limit=100, + next_token="", ) paginator.has_next # Whether there is a next page paginator.next_token # Next page token # Fetch the next page - paginator.next_items() # $HighlightLine + paginator.next_items() ``` @@ -220,7 +220,7 @@ You can fetch all pages by looping through the paginator while checking if there // Loop through all pages const sandboxes: SandboxInfo[] = [] - while (paginator.hasNext) { // $HighlightLine + while (paginator.hasNext) { const items = await paginator.nextItems() sandboxes.push(...items) } @@ -232,7 +232,7 @@ You can fetch all pages by looping through the paginator while checking if there # Loop through all pages sandboxes: list[SandboxInfo] = [] - while paginator.has_next: # $HighlightLine + while paginator.has_next: items = paginator.next_items() sandboxes.extend(items) ``` @@ -257,7 +257,7 @@ You can fetch all pages by looping through the paginator while checking if there }) // List all running sandboxes. - const runningSandboxes = await Sandbox.list() // $HighlightLine + const runningSandboxes = await Sandbox.list() const runningSandbox = runningSandboxes[0] console.log('Running sandbox metadata:', runningSandbox.metadata) @@ -276,7 +276,7 @@ You can fetch all pages by looping through the paginator while checking if there ) # List all running sandboxes. - running_sandboxes = Sandbox.list() # $HighlightLine + running_sandboxes = Sandbox.list() running_sandbox = running_sandboxes[0] print('Running sandbox metadata:', running_sandbox.metadata) @@ -300,16 +300,16 @@ This can be useful when you have a large number of sandboxes and want to find on // Create sandbox with metadata. const sandbox = await Sandbox.create({ metadata: { - env: 'dev', // $HighlightLine - app: 'my-app', // $HighlightLine - userId: '123', // $HighlightLine + env: 'dev', + app: 'my-app', + userId: '123', }, }) // List running sandboxes that has `userId` key with value `123` and `env` key with value `dev`. const runningSandboxes = await Sandbox.list({ query: { - metadata: { userId: '123', env: 'dev' }, // $HighlightLine + metadata: { userId: '123', env: 'dev' }, }, }) ``` @@ -320,9 +320,9 @@ This can be useful when you have a large number of sandboxes and want to find on # Create sandbox with metadata. sandbox = Sandbox.create( metadata={ - "env": "dev", # $HighlightLine - "app": "my-app", # $HighlightLine - "user_id": "123", # $HighlightLine + "env": "dev", + "app": "my-app", + "user_id": "123", }, ) @@ -330,8 +330,8 @@ This can be useful when you have a large number of sandboxes and want to find on running_sandboxes = Sandbox.list( query=SandboxQuery( metadata={ - "userId": "123", # $HighlightLine - "env": "dev", # $HighlightLine + "userId": "123", + "env": "dev", } ), ) diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx index 26e2ce5f0a..b45f88cbb3 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metadata/index.mdx @@ -23,7 +23,7 @@ import { Sandbox } from '@e2b/code-interpreter' // Create sandbox with metadata. const sandbox = await Sandbox.create({ metadata: { - userId: '123', // $HighlightLine + userId: '123', }, }) @@ -41,7 +41,7 @@ from e2b_code_interpreter import Sandbox # Create sandbox with metadata. sandbox = Sandbox.create( metadata={ - 'userId': '123', # $HighlightLine + 'userId': '123', }, ) diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx index 99d6545685..99769f479a 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/metrics/index.mdx @@ -12,7 +12,7 @@ The metrics are collected every 5 seconds. ### Getting sandbox metrics using the SDKs -```js JavaScript & TypeScript +```js JavaScript & TypeScript highlight={9} import { Sandbox } from '@e2b/code-interpreter' const sbx = await Sandbox.create() @@ -21,7 +21,7 @@ console.log('Sandbox created', sbx.sandboxId) // Wait for a few seconds to collect some metrics await new Promise((resolve) => setTimeout(resolve, 10_000)) -const metrics = await sbx.getMetrics() // $HighlightLine +const metrics = await sbx.getMetrics() // You can also get the metrics by sandbox ID: // const metrics = await Sandbox.getMetrics(sbx.sandboxId) @@ -50,7 +50,7 @@ console.log('Sandbox metrics:', metrics) // } // ] ``` -```python Python +```python Python highlight={10} from time import sleep from e2b_code_interpreter import Sandbox @@ -60,7 +60,7 @@ print('Sandbox created', sbx.sandbox_id) # Wait for a few seconds to collect some metrics sleep(10) -metrics = sbx.get_metrics() # $HighlightLine +metrics = sbx.get_metrics() # You can also get the metrics by sandbox ID: # metrics = Sandbox.get_metrics(sbx.sandbox_id) @@ -93,8 +93,8 @@ print('Sandbox metrics', metrics) ### Getting sandbox metrics using the CLI -```bash Terminal -e2b sandbox metrics # $HighlightLine +```bash Terminal highlight={1} +e2b sandbox metrics # Metrics for sandbox # diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx index 4cae732d2d..e53ecb317b 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx @@ -73,8 +73,8 @@ console.log('Sandbox created', sbx.sandboxId) // Pause the sandbox // You can save the sandbox ID in your database to resume the sandbox later -await sbx.betaPause() // $HighlightLine -console.log('Sandbox paused', sbx.sandboxId) // $HighlightLine +await sbx.betaPause() +console.log('Sandbox paused', sbx.sandboxId) ``` ```python Python highlight={8-9} from e2b_code_interpreter import Sandbox @@ -84,8 +84,8 @@ print('Sandbox created', sbx.sandbox_id) # Pause the sandbox # You can save the sandbox ID in your database to resume the sandbox later -sbx.beta_pause() # $HighlightLine -print('Sandbox paused', sbx.sandbox_id) # $HighlightLine +sbx.beta_pause() +print('Sandbox paused', sbx.sandbox_id) ``` @@ -107,8 +107,8 @@ await sbx.betaPause() console.log('Sandbox paused', sbx.sandboxId) // Connect to the sandbox (it will automatically resume the sandbox, if paused) -const sameSbx = await sbx.connect() // $HighlightLine -console.log('Connected to the sandbox', sameSbx.sandboxId) // $HighlightLine +const sameSbx = await sbx.connect() +console.log('Connected to the sandbox', sameSbx.sandboxId) ``` ```python Python highlight={12-13} from e2b_code_interpreter import Sandbox @@ -122,8 +122,8 @@ sbx.beta_pause() print('Sandbox paused', sandbox_id) # Connect to the sandbox (it will automatically resume the sandbox, if paused) -same_sbx = sbx.connect() # $HighlightLine -print('Connected to the sandbox', same_sbx.sandbox_id) # $HighlightLine +same_sbx = sbx.connect() +print('Connected to the sandbox', same_sbx.sandbox_id) ``` @@ -136,10 +136,10 @@ More information about using the method can be found in [List Sandboxes](/sandbo import { Sandbox, SandboxInfo } from '@e2b/code-interpreter' // List all paused sandboxes -const paginator = Sandbox.list({ query: { state: ['paused'] } }) // $HighlightLine +const paginator = Sandbox.list({ query: { state: ['paused'] } }) // Get the first page of paused sandboxes -const sandboxes = await paginator.nextItems() // $HighlightLine +const sandboxes = await paginator.nextItems() // Get all paused sandboxes while (paginator.hasNext) { @@ -151,10 +151,10 @@ while (paginator.hasNext) { # List all paused sandboxes from e2b_code_interpreter import Sandbox, SandboxQuery, SandboxState -paginator = Sandbox.list(SandboxQuery(state=[SandboxState.PAUSED])) # $HighlightLine +paginator = Sandbox.list(SandboxQuery(state=[SandboxState.PAUSED])) # Get the first page of paused sandboxes -sandboxes = paginator.next_items() # $HighlightLine +sandboxes = paginator.next_items() # Get all paused sandboxes while paginator.has_next: @@ -179,10 +179,10 @@ console.log('Sandbox created', sbx.sandboxId) await sbx.betaPause() // Remove the sandbox -await sbx.kill() // $HighlightLine +await sbx.kill() // Remove sandbox by id -await Sandbox.kill(sbx.sandboxId) // $HighlightLine +await Sandbox.kill(sbx.sandboxId) ``` ```python Python highlight={9,12} from e2b_code_interpreter import Sandbox @@ -193,10 +193,10 @@ sbx = Sandbox.create() sbx.beta_pause() # Remove the sandbox -sbx.kill() # $HighlightLine +sbx.kill() # Remove sandbox by id -Sandbox.kill(sbx.sandbox_id) # $HighlightLine +Sandbox.kill(sbx.sandbox_id) ``` diff --git a/apps/web/src/app/(docs)/mintlify-docs/style.css b/apps/web/src/app/(docs)/mintlify-docs/style.css index 470feb3087..13432b0235 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/style.css +++ b/apps/web/src/app/(docs)/mintlify-docs/style.css @@ -1,9 +1,11 @@ +@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;1,100;1,200;1,300;1,400;1,500;1,600;1,700&display=swap'); + #topbar-links { background-color: var(--background-white); } /* Add styles specifically for the Sign In link */ -a[href*="auth/sign-in"].whitespace-nowrap.font-medium { +a[href*='auth/sign-in'].whitespace-nowrap.font-medium { background-color: black; color: white !important; padding: 0.5rem 1rem; @@ -11,18 +13,22 @@ a[href*="auth/sign-in"].whitespace-nowrap.font-medium { transition: background-color 0.2s ease; } -a[href*="auth/sign-in"].whitespace-nowrap.font-medium:hover { +a[href*='auth/sign-in'].whitespace-nowrap.font-medium:hover { background-color: #333; color: white !important; } /* Dark mode styles */ -.dark a[href*="auth/sign-in"].whitespace-nowrap.font-medium { +.dark a[href*='auth/sign-in'].whitespace-nowrap.font-medium { background-color: white; color: black !important; } -.dark a[href*="auth/sign-in"].whitespace-nowrap.font-medium:hover { +.dark a[href*='auth/sign-in'].whitespace-nowrap.font-medium:hover { background-color: #f3f3f3; color: black !important; } + +code { + font-family: 'IBM Plex Mono'; +} From 087eac9b4b7ce96dfc230b500258cf95f0484f95 Mon Sep 17 00:00:00 2001 From: gabrielraeder Date: Tue, 30 Sep 2025 11:26:54 -0300 Subject: [PATCH 3/4] fix codeblock title --- .../mintlify-docs/legacy/hello-world/py/index.mdx | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx index f52dbac5f9..146c7c2e4e 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/legacy/hello-world/py/index.mdx @@ -52,7 +52,8 @@ Usually, all you need from the model is just support for tool use. If the LLM do Create the `model.py` file and paste the following code. -```python model.py +```python Python +# model.py MODEL_NAME = "claude-3-opus-20240229" SYSTEM_PROMPT = """ @@ -94,7 +95,8 @@ A little bit later, we'll connect `"execute_python"` to the E2B's code interpret We'll create a new function called `code_interpret()` in a separate file `code_interpreter.py`. -```python code_interpreter.py +```python Python +# code_interpreter.py from e2b_code_interpreter import CodeInterpreter def code_interpret(code_interpreter: CodeInterpreter, code: str): @@ -187,7 +189,8 @@ def chat(code_interpreter: CodeInterpreter, user_message: str) -> Tuple[List[Res Now we are ready to run our program. At the end of `main.py` add the following code prompting the LLM to visualize a distribution of the height of men and print the median. -```python main.py +```python Python +# main.py def main(): user_message = "Visualize a distribution of height of men based on the latest data you know. Also, print the median value." @@ -228,7 +231,8 @@ We got our median in the logs (`stdout`, and `stderr`) but we also something int This looks like a plot. Let's save it to a file. Add the following to the end of `main.py` and run the code again with `python main.py` in your terminal. -```python main.py +```python Python +# main.py # If we received a chart in PNG form, we can visualize it if first_result.png: # Decode the base64 encoded PNG data From 587c00a4db59e77127da00490d2a10100dc3e116 Mon Sep 17 00:00:00 2001 From: Mish <10400064+mishushakov@users.noreply.github.com> Date: Tue, 7 Oct 2025 18:34:02 +0200 Subject: [PATCH 4/4] updated sandbox retention policy details --- .../src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx b/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx index e53ecb317b..86254c7cc2 100644 --- a/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx +++ b/apps/web/src/app/(docs)/mintlify-docs/sandbox/persistence/index.mdx @@ -274,4 +274,4 @@ If you resume the sandbox, the service will be accessible again but you need to - Pausing a sandbox takes about 4 seconds per 1 GiB of RAM - Resuming a sandbox takes about 1 second - Sandbox can be used up to 30 days - - After 30 days from the initial sandbox create call, the data may be deleted and you will not be able to resume it. Attempting to resume a sandbox that was deleted or does not exist will result in the `NotFoundError` in the JavaScript SDK or the `NotFoundException` in the Python SDK \ No newline at end of file + - After 30 days from the sandbox creation, the sandbox data may be deleted. This retention period is based on the original sandbox creation date and is not extended or reset by subsequent resumes. Attempting to resume a sandbox that was deleted or does not exist will result in a `NotFoundError` (JavaScript SDK) or `NotFoundException` (Python SDK). \ No newline at end of file