feat(cli): add pause and resume commands for sandboxes (#1170)

Co-authored-by: djeebot <djeebot@users.noreply.github.com>
Co-authored-by: Joseph Lombrozo <joe.lombrozo@e2b.dev>

Author: 3 people

.changeset/add-pause-command.md

@@ -0,0 +1,8 @@
+---
+"@e2b/cli": minor
+---
+
+Add `pause` and `resume` commands to manage sandbox state.
+
+- `e2b sandbox pause <sandboxID>` - pause a running sandbox
+- `e2b sandbox resume <sandboxID>` - resume a paused sandbox

packages/cli/src/commands/sandbox/index.ts

@@ -3,6 +3,8 @@ import * as commander from 'commander'
 import { connectCommand } from './connect'
 import { listCommand } from './list'
 import { killCommand } from './kill'
+import { pauseCommand } from './pause'
+import { resumeCommand } from './resume'
 import { createCommand } from './create'
 import { logsCommand } from './logs'
 import { metricsCommand } from './metrics'
@@ -14,6 +16,8 @@ export const sandboxCommand = new commander.Command('sandbox')
   .addCommand(connectCommand)
   .addCommand(listCommand)
   .addCommand(killCommand)
+  .addCommand(pauseCommand)
+  .addCommand(resumeCommand)
   .addCommand(createCommand('create', 'cr', false))
   .addCommand(createCommand('spawn', 'sp', true), { hidden: true })
   .addCommand(logsCommand)

packages/cli/src/commands/sandbox/pause.ts

@@ -0,0 +1,40 @@
+import * as commander from 'commander'
+
+import { ensureAPIKey } from 'src/api'
+import { asBold } from 'src/utils/format'
+import * as e2b from 'e2b'
+import { NotFoundError } from 'e2b'
+
+async function pauseSandbox(sandboxID: string, apiKey: string) {
+  try {
+    const paused = await e2b.Sandbox.betaPause(sandboxID, { apiKey })
+    if (paused) {
+      console.log(`Sandbox ${asBold(sandboxID)} has been paused`)
+    } else {
+      console.log(`Sandbox ${asBold(sandboxID)} is already paused`)
+    }
+  } catch (err: unknown) {
+    if (err instanceof NotFoundError) {
+      console.error(`Sandbox ${asBold(sandboxID)} wasn't found`)
+      process.exit(1)
+    }
+    throw err
+  }
+}
+
+export const pauseCommand = new commander.Command('pause')
+  .description('pause sandbox')
+  .argument(
+    '<sandboxID>',
+    `pause the sandbox specified by ${asBold('<sandboxID>')}`
+  )
+  .alias('ps')
+  .action(async (sandboxID: string) => {
+    try {
+      const apiKey = ensureAPIKey()
+      await pauseSandbox(sandboxID, apiKey)
+    } catch (err: unknown) {
+      console.error(err)
+      process.exit(1)
+    }
+  })

packages/cli/src/commands/sandbox/resume.ts

@@ -0,0 +1,36 @@
+import * as commander from 'commander'
+
+import { ensureAPIKey } from 'src/api'
+import { asBold } from 'src/utils/format'
+import * as e2b from 'e2b'
+import { NotFoundError } from 'e2b'
+
+async function resumeSandbox(sandboxID: string, apiKey: string) {
+  try {
+    await e2b.Sandbox.connect(sandboxID, { apiKey })
+    console.log(`Sandbox ${asBold(sandboxID)} has been resumed`)
+  } catch (err: unknown) {
+    if (err instanceof NotFoundError) {
+      console.error(`Sandbox ${asBold(sandboxID)} wasn't found`)
+      process.exit(1)
+    }
+    throw err
+  }
+}
+
+export const resumeCommand = new commander.Command('resume')
+  .description('resume paused sandbox')
+  .argument(
+    '<sandboxID>',
+    `resume the sandbox specified by ${asBold('<sandboxID>')}`
+  )
+  .alias('rs')
+  .action(async (sandboxID: string) => {
+    try {
+      const apiKey = ensureAPIKey()
+      await resumeSandbox(sandboxID, apiKey)
+    } catch (err: unknown) {
+      console.error(err)
+      process.exit(1)
+    }
+  })