Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

9.1 KB
Raw Blame
import { input, select } from '@inquirer/prompts'
import PackageJson from '@npmcli/package-json'
import * as commander from 'commander'
import { Template } from 'e2b'
import * as fs from 'fs'
import * as path from 'path'
import { pathOption } from 'src/options'
import { getRoot } from 'src/utils/filesystem'
import { asPrimary } from 'src/utils/format'
import { validateTemplateName } from 'src/utils/templateName'
import {
  generateAndWriteTemplateFiles,
  GeneratedFiles,
  Language,
  languageDisplay,
  parseLanguage,
} from './generators'
import { generateReadmeContent } from './generators/handlebars'

const DEFAULT_TEMPLATE_NAME = 'my-template'

/**
 * Generate template files using shared template generation logic
 */
async function generateTemplateFiles(
  root: string,
  name: string,
  language: Language,
  cpuCount?: number,
  memoryMB?: number
): Promise<GeneratedFiles> {
  const template = Template().fromBaseImage().runCmd('echo Hello World E2B!')

  return generateAndWriteTemplateFiles(
    root,
    name,
    language,
    template,
    cpuCount,
    memoryMB
  )
}

/**
 * Add build scripts to Makefile if it exists or create a new one
 */
async function addMakefileScripts(
  root: string,
  files: GeneratedFiles,
  templateDirName: string
): Promise<void> {
  try {
    const makefileName = 'Makefile'
    const makefileExists = fs.existsSync(path.join(root, makefileName))

    let cdPrefix = ''
    if (makefileExists) {
      cdPrefix = `cd ${templateDirName} && `
    }

    const makefileContent = `
.PHONY: e2b:build:dev
e2b:build:dev:
\t${cdPrefix}python ${files.buildDevFile}

.PHONY: e2b:build:prod
e2b:build:prod:
\t${cdPrefix}python ${files.buildProdFile}
`

    if (makefileExists) {
      const makefilePath = path.join(root, makefileName)
      await fs.promises.appendFile(makefilePath, '\n' + makefileContent, 'utf8')
    } else {
      // Create a basic Makefile if it doesn't exist
      const makefilePath = path.join(root, templateDirName, makefileName)
      await fs.promises.writeFile(makefilePath, makefileContent, 'utf8')
    }

    console.log('\nπŸ“ Added build scripts to Makefile:')
    console.log(
      `   ${asPrimary('make e2b:build:dev')} - Build development template`
    )
    console.log(
      `   ${asPrimary('make e2b:build:prod')} - Build production template`
    )
  } catch (err) {
    console.warn(
      '\n⚠️  Could not add scripts to Makefile:',
      err instanceof Error ? err.message : err
    )
  }
}

/**
 * Add build scripts to package.json if it exists or create a new one
 */
async function addPackageJsonScripts(
  root: string,
  files: GeneratedFiles,
  templateDirName: string
): Promise<void> {
  try {
    let cdPrefix = ''
    let pkgJson: PackageJson
    try {
      // The library expects the directory path, not the full file path
      pkgJson = await PackageJson.load(root)
      cdPrefix = `cd ${templateDirName} && `
    } catch (error) {
      // Handle the case where package.json does not exist
      const createRoot = path.join(root, templateDirName)
      pkgJson = await PackageJson.create(createRoot)
    }

    pkgJson.update({
      scripts: {
        ...pkgJson.content.scripts,
        'e2b:build:dev': `${cdPrefix}npx tsx ${files.buildDevFile}`,
        'e2b:build:prod': `${cdPrefix}npx tsx ${files.buildProdFile}`,
      },
    })

    // Save the changes
    await pkgJson.save()

    console.log('\nπŸ“ Added build scripts to package.json:')
    console.log(
      `   ${asPrimary('npm run e2b:build:dev')} - Build development template`
    )
    console.log(
      `   ${asPrimary('npm run e2b:build:prod')} - Build production template`
    )
  } catch (err) {
    console.warn(
      '\n⚠️  Could not add scripts to package.json:',
      err instanceof Error ? err.message : err
    )
  }
}

export const initCommand = new commander.Command('init')
  .description('initialize a new sandbox template using the SDK')
  .addOption(pathOption)
  .option('-n, --name <name>', 'template name', (value) => {
    try {
      return validateTemplateName(value)
    } catch (err) {
      throw new commander.InvalidArgumentError(
        err instanceof Error ? err.message : String(err)
      )
    }
  })
  .option(
    '-l, --language <language>',
    `target language: ${Object.values(Language).join(', ')}`,
    parseLanguage
  )
  .alias('it')
  .action(
    async (opts: { path?: string; name?: string; language?: Language }) => {
      try {
        process.stdout.write('\n')

        const root = getRoot(opts.path)

        console.log('πŸš€ Initializing Sandbox Template...\n')

        // Step 1: Get template name (from CLI or prompt)
        let templateName: string = opts.name ?? DEFAULT_TEMPLATE_NAME
        if (opts.name === undefined) {
          templateName = await input({
            message: 'Enter template name:',
            default: DEFAULT_TEMPLATE_NAME,
            validate: (input: string) => {
              try {
                validateTemplateName(input)
              } catch (err) {
                return err instanceof Error ? err.message : err
              }

              return true
            },
          })
        }
        templateName = validateTemplateName(templateName)
        console.log(`Using template name: ${templateName}`)

        // Step 2: Get language (from CLI or prompt)
        let language: Language
        if (opts.language) {
          language = opts.language
          console.log(`Using language: ${languageDisplay[language]}`)
        } else {
          language = await select({
            message: 'Select target language for template files:',
            choices: [
              {
                name: languageDisplay[Language.TypeScript],
                value: Language.TypeScript,
                description:
                  'Generate .ts files for JavaScript/TypeScript projects',
              },
              {
                name: languageDisplay[Language.PythonSync],
                value: Language.PythonSync,
                description: 'Generate synchronous Python template files',
              },
              {
                name: languageDisplay[Language.PythonAsync],
                value: Language.PythonAsync,
                description: 'Generate asynchronous Python template files',
              },
            ],
            default: Language.TypeScript,
          })
        }

        // Step 3: Create template directory - fail if it already exists
        const templateDirName = templateName
        const templateDir = path.join(root, templateDirName)

        if (fs.existsSync(templateDir)) {
          throw new Error(
            `Directory '${templateDirName}' already exists. Please choose a different template name or remove the existing directory.`
          )
        }

        await fs.promises.mkdir(templateDir, { recursive: true })

        // Step 4: Generate template and build files in the template directory
        const generatedFiles = await generateTemplateFiles(
          templateDir,
          templateName,
          language
        )

        // Step 5: Add scripts
        switch (language) {
          case Language.TypeScript:
            await addPackageJsonScripts(root, generatedFiles, templateDirName)
            break
          case Language.PythonAsync:
          case Language.PythonSync:
            await addMakefileScripts(root, generatedFiles, templateDirName)
            break
          default:
            throw new Error('Unsupported language for scripts')
        }

        // Step 6: Create README.md
        const readmeContent = await generateReadmeContent(
          templateName,
          templateDirName,
          generatedFiles
        )
        const readmeFilePath = path.join(templateDir, 'README.md')
        await fs.promises.writeFile(readmeFilePath, readmeContent, 'utf8')

        console.log('\nπŸŽ‰ Template initialized successfully!')
        console.log(
          `\nTemplate created in: ${asPrimary(`./${templateDirName}/`)}`
        )
        console.log('\nπŸ”¨ To get started with your template:')

        switch (language) {
          case Language.TypeScript:
            console.log(
              `   ${asPrimary('npm install e2b')} (install e2b dependency)`
            )
            console.log(
              `   ${asPrimary('npm run e2b:build:dev')} (for development)`
            )
            console.log(
              `   ${asPrimary('npm run e2b:build:prod')} (for production)`
            )
            break
          case Language.PythonAsync:
          case Language.PythonSync:
            console.log(
              `   ${asPrimary('pip install e2b')} (install e2b dependency)`
            )
            console.log(
              `   ${asPrimary('make e2b:build:dev')} (for development)`
            )
            console.log(
              `   ${asPrimary('make e2b:build:prod')} (for production)`
            )
            break
          default:
            throw new Error('Unsupported language for instructions')
        }

        console.log(
          `\nLearn more about Sandbox Templates: ${asPrimary(
            'https://e2b.dev/docs'
          )}\n`
        )
      } catch (err: any) {
        console.error(err)
        process.exit(1)
      }
    }
  )