@embeddable.com/init 0.1.4 → 0.1.6

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() {
@@ -141,7 +142,7 @@ Failed to download boilerplate: ${message}
     {
       type: "password",
       name: "apiKey",
-      message: `You'll need an API Key to push this code bundle to your workspace 
+      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")}). 
 
 Paste your API Key here:`,
@@ -165,7 +166,7 @@ Paste your API Key here:`,
     {
       type: "select",
       name: "region",
-      message: "Confirm your workspace region:",
+      message: "Confirm your workspace region (you can find this in your workspace):",
       choices: [
         { title: "US", value: "US" },
         { title: "EU", value: "EU" }
@@ -226,19 +227,19 @@ 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
   });
   console.log(chalk.green(`
 Success!
 `));
-  console.log(`You have pushed your ${chalk.bold("components")} and ${chalk.bold("data models")} to workspace.`);
+  console.log(`You have pushed Embeddable's ${chalk.bold("default chart library")} and sample ${chalk.bold("data models")} to your workspace.`);
   console.log(`Refresh your workspace page to see the "Create new Embeddable" button and the sample dashboards: ${chalk.cyan(workspaceLink)}
 `);
   console.log(`Follow the guide here to create your first Embeddable dashboard: ${chalk.cyan(docsLink)}
 `);
-  await open(workspaceUrl);
+  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.4",
+  "version": "0.1.6",
   "description": "CLI tool for Embeddable",
   "type": "module",
   "bin": {