Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/e2b-dev/e2b
Browse files Browse the repository at this point in the history
  • Loading branch information
ValentaTomas committed Nov 10, 2023
2 parents 0ea0204 + 67564bc commit 5da9f49
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 37 deletions.
54 changes: 27 additions & 27 deletions apps/docs/src/app/cli/commands/page.mdx
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# CLI Commands

Build your own sandbox with our CLI. {{ className: 'lead' }}
Build your sandbox with our CLI. {{ className: 'lead' }}

You append always use `--help` for more information about commands and options.
You can always use `--help` for more information about commands and options.

## `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.
Build a sandbox template defined by `./e2b.Dockerfile` or `./Dockerfile` in the root directory. By default, the root directory is the current working directory. This command also creates the `e2b.toml` config.

```bash
e2b build
```

### Options:
#### **Options**

<Properties>
<Property name="name" type="-n --name">
Specify name of sandbox template. You can use the name to start the sandbox in the SDK. The name must be lowercase and contain only letters, numbers, dashes and underscores.
</Property>
<Property name="path" type="-p --path">
Change root directory where command is executed to `path` directory
</Property>
<Property name="dockerfile" type="-d --dockerfile">
Specify path to Dockerfile. By default E2B tries to find `e2b.Dockerfile` or `Dockerfile` in root directory
</Property>
</Properties>
<Options>
<Option name="name" type="-n, --name">
Specify the name of the sandbox template. You can use the name to start the sandbox in the SDK. The name must be lowercase and contain only letters, numbers, dashes, and underscores
</Option>
<Option name="path" type="-p, --path">
Change the root directory where command is executed to the `path` directory
</Option>
<Option name="dockerfile" type="-d, --dockerfile">
Specify the path to Dockerfile. By default E2B tries to find `e2b.Dockerfile` or `Dockerfile` in the root directory
</Option>
</Options>

---

Expand All @@ -36,13 +36,13 @@ Create basic E2B Dockerfile (`./e2b.Dockerfile`) in current directory. You can t
e2b template init
```

### Options:
#### **Options**

<Properties>
<Property name="path" type="-p --path">
Change root directory where command is executed to `path` directory
</Property>
</Properties>
<Options>
<Option name="path" type="-p, --path">
Change the root directory where command is executed to `path` directory
</Option>
</Options>

---

Expand All @@ -68,7 +68,7 @@ e2b login

## `logout`

Log out from CLI. It will remove your accesstoken from `~/.e2b` file.
Log out from CLI. It will remove your access token from `~/.e2b` file.

```bash
e2b logout
Expand All @@ -84,13 +84,13 @@ Connect terminal to sandbox. This command can be used to debug your sandbox temp
e2b shell
```

### Options:
#### **Options**

<Properties>
<Property name="path" type="-p --path">
<Options>
<Option name="path" type="-p, --path">
Change root directory where command is executed to `path` directory
</Property>
</Properties>
</Option>
</Options>

### Next steps

Expand Down
18 changes: 9 additions & 9 deletions apps/docs/src/components/mdx.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export function Col({
)
}

export function Properties({ children }: { children: React.ReactNode }) {
export function Options({ children }: { children: React.ReactNode }) {
return (
<div className="my-6">
<ul
Expand All @@ -113,11 +113,11 @@ export function Properties({ children }: { children: React.ReactNode }) {
)
}

export function Property({
name,
children,
type,
}: {
export function Option({
name,
children,
type,
}: {
name: string
children: React.ReactNode
type?: string
Expand All @@ -127,12 +127,12 @@ export function Property({
<dl className="m-0 flex flex-wrap items-center gap-x-3 gap-y-2">
<dt className="sr-only">Name</dt>
<dd>
<code>{name}</code>
<code className="text-zinc-300 dark:text-zinc-400">{name}</code>
</dd>
{type && (
<>
<dt className="sr-only">Type</dt>
<dd className="font-mono text-xs text-zinc-400 dark:text-zinc-500">{type}</dd>
<dt className="sr-only">Flags</dt>
<dd className="font-mono text-xs text-zinc-600 dark:text-white"> {type}</dd>
</>
)}
<dt className="sr-only">Description</dt>
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/commands/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export const buildCommand = new commander.Command('build')
)
.option(
'-n, --name <name>',
'Specify name of sandbox template. You can use the name to start the sandbox in the SDK. The name must be lowercase and contain only letters, numbers, dashes and underscores.',
'Specify name of sandbox template. You can use the name to start the sandbox in the SDK. The name must be lowercase and contain only letters, numbers, dashes and underscores',
)
.alias('bd')
.action(
Expand Down

1 comment on commit 5da9f49

@vercel
Copy link

@vercel vercel bot commented on 5da9f49 Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

e2b-docs – ./apps/docs

e2b-docs.vercel.app
e2b-docs-git-main-e2b.vercel.app
e2b-docs-e2b.vercel.app

Please sign in to comment.