diff --git a/.changeset/heavy-cycles-joke.md b/.changeset/heavy-cycles-joke.md new file mode 100644 index 0000000000..06ad57ae39 --- /dev/null +++ b/.changeset/heavy-cycles-joke.md @@ -0,0 +1,5 @@ +--- +'@e2b/cli': patch +--- + +add dependency notice to template migrate command diff --git a/packages/cli/src/commands/template/init.ts b/packages/cli/src/commands/template/init.ts index c534d7ca2a..9fd9ae6078 100644 --- a/packages/cli/src/commands/template/init.ts +++ b/packages/cli/src/commands/template/init.ts @@ -288,10 +288,13 @@ export const initCommand = new commander.Command('init') console.log( `\nTemplate created in: ${asPrimary(`./${templateDirName}/`)}` ) - console.log('\nYou can now build your template using:') + 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)` ) @@ -301,6 +304,9 @@ export const initCommand = new commander.Command('init') 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)` ) diff --git a/packages/cli/src/commands/template/migrate.ts b/packages/cli/src/commands/template/migrate.ts index 238c72f9df..9375053e28 100644 --- a/packages/cli/src/commands/template/migrate.ts +++ b/packages/cli/src/commands/template/migrate.ts @@ -209,20 +209,26 @@ export const migrateCommand = new commander.Command('migrate') console.log('\n🎉 Migration completed successfully!') - console.log('\n🔨 You can now build your template using:') + console.log('\n🔨 To get started with your template:') if (language === Language.TypeScript) { console.log( - ` ${asPrimary('npx tsx build.dev.ts')} (for development)` + ` ${asPrimary('npm install e2b')} (install e2b dependency)` ) console.log( - ` ${asPrimary('npx tsx build.prod.ts')} (for production)` + ` ${asPrimary('npx tsx build.dev.ts')} (run development build)` + ) + console.log( + ` ${asPrimary('npx tsx build.prod.ts')} (run production build)` ) } else { console.log( - ` ${asPrimary('python build_dev.py')} (for development)` + ` ${asPrimary('pip install e2b')} (install e2b dependency)` + ) + console.log( + ` ${asPrimary('python build_dev.py')} (run development build)` ) console.log( - ` ${asPrimary('python build_prod.py')} (for production)` + ` ${asPrimary('python build_prod.py')} (run production build)` ) } diff --git a/packages/cli/src/templates/readme.hbs b/packages/cli/src/templates/readme.hbs index 62b2c1100c..9c95e0d3ad 100644 --- a/packages/cli/src/templates/readme.hbs +++ b/packages/cli/src/templates/readme.hbs @@ -16,6 +16,16 @@ Before you begin, make sure you have: E2B_API_KEY=your_api_key_here ``` +## Installing Dependencies + +```bash +{{#if isTypeScript}} +npm install e2b +{{else if isPython}} +pip install e2b +{{/if}} +``` + ## Building the Template ```bash