forked from e2b-dev/E2B
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
66b8729
commit 52feefc
Showing
5 changed files
with
280 additions
and
6 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
58 changes: 58 additions & 0 deletions
58
apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.7/auth/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
## 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] | ||
``` | ||
|
||
|
89 changes: 89 additions & 0 deletions
89
apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.7/sandbox/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
## 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] <sandboxID> | ||
``` | ||
|
||
|
||
## 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 <path>: change root directory where command is executed to <path> directory ` | ||
- `--config <e2b-toml>: 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] <sandboxID> | ||
``` | ||
|
||
### Options | ||
|
||
|
||
- `--level <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 <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. ` | ||
|
||
|
132 changes: 132 additions & 0 deletions
132
apps/web/src/app/(docs)/docs/sdk-reference/cli/v1.0.7/template/page.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
## 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 <path>: change root directory where command is executed to <path> directory ` | ||
- `-d, --dockerfile <file>: specify path to Dockerfile. By default E2B tries to find e2b.Dockerfile or Dockerfile in root directory. ` | ||
- `-n, --name <template-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 <start-command>: specify command that will be executed when the sandbox is started. ` | ||
- `-t, --team <team-id>: 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 <e2b-toml>: specify path to the E2B config toml. By default E2B tries to find ./e2b.toml in root directory. ` | ||
- `--cpu-count <cpu-count>: specify the number of CPUs that will be used to run the sandbox. The default value is 2. ` | ||
- `--memory-mb <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 <args...>: specify additional build arguments for the build command. The format should be <varname>=<value>. ` | ||
|
||
|
||
## e2b template list | ||
|
||
|
||
list sandbox templates | ||
|
||
### Usage | ||
|
||
```bash | ||
e2b template list [options] | ||
``` | ||
|
||
### Options | ||
|
||
|
||
- `-t, --team <team-id>: 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 <path>: change root directory where command is executed to <path> directory ` | ||
|
||
|
||
## e2b template delete | ||
|
||
|
||
delete sandbox template and e2b.toml config | ||
|
||
### Usage | ||
|
||
```bash | ||
e2b template delete [options] [template] | ||
``` | ||
|
||
### Options | ||
|
||
|
||
- `-p, --path <path>: change root directory where command is executed to <path> directory ` | ||
- `--config <e2b-toml>: 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 <team-id>: 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 <path>: change root directory where command is executed to <path> directory ` | ||
- `--config <e2b-toml>: 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 <team-id>: 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 <path>: change root directory where command is executed to <path> directory ` | ||
- `--config <e2b-toml>: 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 <team-id>: 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 ` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters