@embeddable.com/init

A CLI tool that helps you quickly set up your first Embeddable project. It guides you through the entire onboarding process—from project creation to pushing your first components to your workspace.

Usage

Run the following command to get started:

npx @embeddable.com/init

The CLI will walk you through:

1. Creating a new project folder
2. Downloading the boilerplate project template
3. Installing dependencies
4. Configuring your API credentials and region (US/EU)
5. Building and deploying your initial bundle to your Embeddable workspace

Requirements

• Node.js 20 or higher
• An Embeddable account with an API key

Development

Setup

npm install

Build

npm run build

Watch mode

npm run dev

Run tests

npm test

The test suite covers:

• User cancellation at each prompt stage
• Error handling (network failures, npm install failures, build/push failures)
• Happy path flows for both US and EU regions
• Non-fatal warnings (git init failure, config update issues)
• Cleanup behavior on failure

Test locally

After building, you can test the CLI locally:

node dist/index.js

or run from a separate directory:

npx <path-to-this-repo>

Publishing to npm

Publishing happens automatically when code is merged to main. The GitHub Action will:

1. Build the package
2. Bump the patch version
3. Publish to npm
4. Push the version bump commit back to the repo

To verify a release:

npm view @embeddable.com/init

Project Structure

├── src/
│   └── index.ts        # Main CLI application
├── test/
│   └── index.test.ts   # Test suite
├── dist/               # Compiled output (generated)
├── package.json        # Package configuration
├── tsconfig.json       # TypeScript configuration
└── tsup.config.ts      # Build configuration

License

MIT