@embeddable.com/init 0.1.5 → 0.1.7

package/README.md

@@ -0,0 +1,105 @@
+# @embeddable.com/init
+
+A CLI tool that helps you quickly set up your first [Embeddable](https://embeddable.com) 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:
+
+```bash
+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
+
+```bash
+npm install
+```
+
+### Build
+
+```bash
+npm run build
+```
+
+### Watch mode
+
+```bash
+npm run dev
+```
+
+### Test locally
+
+After building, you can test the CLI locally:
+
+```bash
+node dist/index.js
+```
+
+or run from a separate directory:
+
+```bash
+npx <path-to-this-repo>
+```
+
+## Publishing to npm
+
+### Prerequisites
+
+1. Ensure you have an npm account with access to the `@embeddable.com` scope
+2. Log in to npm:
+   ```bash
+   npm login
+   ```
+
+### Publishing
+
+1. Update the version in `package.json`:
+   ```bash
+   npm version patch  # or minor/major
+   ```
+
+2. Publish to npm:
+   ```bash
+   npm publish --access public
+   ```
+
+The `prepublishOnly` script will automatically run the build before publishing.
+
+### Verifying the release
+
+After publishing, verify the package is available:
+
+```bash
+npm view @embeddable.com/init
+```
+
+## Project Structure
+
+```
+├── src/
+│   └── index.ts        # Main CLI application
+├── dist/               # Compiled output (generated)
+├── package.json        # Package configuration
+├── tsconfig.json       # TypeScript configuration
+└── tsup.config.ts      # Build configuration
+```
+
+## License
+
+MIT

package/dist/index.js

@@ -19,6 +19,7 @@ var WORKSPACE_URLS = {
 var INVALID_FOLDER_CHARS = /[<>:"/\\|?*\x00-\x1f]/;
 function exit(message) {
   if (message) console.log(message);
+  printDocsHint();
   process.exit(0);
 }
 function printDocsHint() {
@@ -64,7 +65,7 @@ async function main() {
   const onCancel = () => exit("\nSetup cancelled.\n");
   console.log(chalk.white(LOGO));
   await typewriter("Welcome to Embeddable!\n\n", chalk.bold, TYPEWRITER_SPEED);
-  await typewriter("Embeddable stores your ", void 0, TYPEWRITER_SPEED);
+  await typewriter("Embeddable lets you configure your ", void 0, TYPEWRITER_SPEED);
   await typewriter("charting components", chalk.bold, TYPEWRITER_SPEED);
   await typewriter(", ", void 0, TYPEWRITER_SPEED);
   await typewriter("data models", chalk.bold, TYPEWRITER_SPEED);
@@ -77,13 +78,19 @@ async function main() {
   await typewriter(" and the ", void 0, TYPEWRITER_SPEED);
   await typewriter("data", chalk.bold, TYPEWRITER_SPEED);
   await typewriter(" powering your dashboards.\n\n", void 0, TYPEWRITER_SPEED);
-  await typewriter("This tool helps you get set up to create your first Embeddable dashboard.\n\n", void 0, TYPEWRITER_SPEED);
+  await typewriter("This tool creates a ", void 0, TYPEWRITER_SPEED);
+  await typewriter("new folder", chalk.bold, TYPEWRITER_SPEED);
+  await typewriter(", containing ", void 0, TYPEWRITER_SPEED);
+  await typewriter("sample data models", chalk.bold, TYPEWRITER_SPEED);
+  await typewriter(" and ", void 0, TYPEWRITER_SPEED);
+  await typewriter("themes", chalk.bold, TYPEWRITER_SPEED);
+  await typewriter(" to help you create your first Embeddable dashboard.\n\n", void 0, TYPEWRITER_SPEED);
   const cwd = process.cwd();
   const { confirmDir } = await prompts(
     {
       type: "confirm",
       name: "confirmDir",
-      message: `Ok to create a new Project subfolder in your current directory ${chalk.cyan(cwd)}?`,
+      message: `Ok to create a new project subfolder in your current directory ${chalk.cyan(cwd)}?`,
       initial: true
     },
     { onCancel }
@@ -142,7 +149,7 @@ Failed to download boilerplate: ${message}
       type: "password",
       name: "apiKey",
       message: `You'll need an API Key to push this code bundle to your account's workspace 
-(to create an account, head to ${chalk.cyan("https://embeddable.com/start")}). 
+(Create your account here: ${chalk.cyan(terminalLink("https://embeddable.com/start", "https://embeddable.com/start", { fallback: (text) => text }))}). 
 
 Paste your API Key here:`,
       validate: (value) => {
@@ -226,7 +233,7 @@ Paste your API Key here:`,
   const workspaceLink = terminalLink(workspaceUrl, workspaceUrl, {
     fallback: (text) => text
   });
-  const docsUrl = "https://docs.embeddable.com/getting-started/first-embeddable";
+  const docsUrl = "https://docs.embeddable.com/getting-started/your-workspace";
   const docsLink = terminalLink(docsUrl, docsUrl, {
     fallback: (text) => text
   });
@@ -238,7 +245,7 @@ Success!
 `);
   console.log(`Follow the guide here to create your first Embeddable dashboard: ${chalk.cyan(docsLink)}
 `);
-  await open("https://docs.embeddable.com/getting-started/set-up-your-workspace#refresh-your-workspace");
+  await open(docsUrl);
 }
 main().catch((error) => {
   console.error(chalk.red("An unexpected error occurred:"), error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embeddable.com/init",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "CLI tool for Embeddable",
   "type": "module",
   "bin": {