@tinybirdco/sdk 0.0.28 → 0.0.30

package/src/cli/index.ts

@@ -27,6 +27,8 @@ import {
   runBranchDelete,
 } from "./commands/branch.js";
 import { runClear } from "./commands/clear.js";
+import { runInfo } from "./commands/info.js";
+import { runOpenDashboard, type Environment } from "./commands/open-dashboard.js";
 import {
   detectPackageManagerInstallCmd,
   detectPackageManagerRunCmd,
@@ -170,6 +172,74 @@ function createCli(): Command {
       }
     });
 
+  // Info command
+  program
+    .command("info")
+    .description("Show information about the current project and workspace")
+    .option("--json", "Output as JSON")
+    .action(async (options) => {
+      const result = await runInfo({ json: options.json });
+
+      if (!result.success) {
+        console.error(`Error: ${result.error}`);
+        process.exit(1);
+      }
+
+      if (options.json) {
+        // JSON output
+        const jsonOutput = {
+          cloud: result.cloud,
+          local: result.local,
+          branch: result.branch,
+          project: result.project,
+          branches: result.branches,
+        };
+        console.log(JSON.stringify(jsonOutput, null, 2));
+      } else {
+        // Human-readable output
+        output.showInfo({
+          cloud: result.cloud,
+          local: result.local,
+          branch: result.branch,
+          project: result.project,
+        });
+      }
+    });
+
+  // Open command
+  program
+    .command("open")
+    .description("Open the Tinybird dashboard in the default browser")
+    .option(
+      "-e, --env <env>",
+      "Which environment to open: 'cloud', 'local', or 'branch'"
+    )
+    .action(async (options) => {
+      const validEnvs = ["cloud", "local", "branch"];
+      if (options.env && !validEnvs.includes(options.env)) {
+        console.error(
+          `Error: Invalid environment '${options.env}'. Use one of: ${validEnvs.join(", ")}`
+        );
+        process.exit(1);
+      }
+
+      const result = await runOpenDashboard({
+        environment: options.env as Environment | undefined,
+      });
+
+      if (!result.success) {
+        console.error(`Error: ${result.error}`);
+        process.exit(1);
+      }
+
+      console.log(`Opening ${result.environment} dashboard...`);
+      if (result.browserOpened) {
+        console.log(`Dashboard: ${result.url}`);
+      } else {
+        console.log(`Could not open browser. Please visit: ${result.url}`);
+      }
+    });
+
   // Build command
   program
     .command("build")

package/src/cli/output.ts

@@ -292,6 +292,116 @@ export function showBranchInfo(info: BranchDisplayInfo): void {
   console.log("");
 }
 
+/**
+ * Info display data
+ */
+export interface InfoDisplayData {
+  cloud?: {
+    workspaceName: string;
+    workspaceId: string;
+    userEmail: string;
+    apiHost: string;
+    dashboardUrl?: string;
+    token: string;
+  };
+  local?: {
+    running: boolean;
+    workspaceName?: string;
+    workspaceId?: string;
+    apiHost: string;
+    dashboardUrl?: string;
+    token?: string;
+  };
+  project?: {
+    cwd: string;
+    configPath: string;
+    devMode: string;
+    gitBranch: string | null;
+    tinybirdBranch: string | null;
+    isMainBranch: boolean;
+  };
+  branch?: {
+    name: string;
+    id: string;
+    token: string;
+    dashboardUrl?: string;
+  };
+}
+
+/**
+ * Show project and workspace info
+ */
+export function showInfo(data: InfoDisplayData): void {
+  // Cloud section
+  if (data.cloud) {
+    highlight("» Workspace:");
+    console.log(`  Name:      ${data.cloud.workspaceName}`);
+    console.log(`  ID:        ${data.cloud.workspaceId}`);
+    console.log(`  User:      ${data.cloud.userEmail}`);
+    console.log(`  API:       ${data.cloud.apiHost}`);
+    if (data.cloud.dashboardUrl) {
+      console.log(`  Dashboard: ${data.cloud.dashboardUrl}`);
+    }
+    console.log(`  Token:     ${data.cloud.token}`);
+    console.log();
+  }
+
+  // Local section
+  if (data.local) {
+    highlight("» Local:");
+    if (!data.local.running) {
+      warning("  Tinybird local is not running.");
+      console.log("  Start with: docker run -d -p 7181:7181 tinybirdco/tinybird-local");
+    } else if (data.local.workspaceName) {
+      console.log(`  Name:      ${data.local.workspaceName}`);
+      console.log(`  ID:        ${data.local.workspaceId}`);
+      console.log(`  API:       ${data.local.apiHost}`);
+      if (data.local.dashboardUrl) {
+        console.log(`  Dashboard: ${data.local.dashboardUrl}`);
+      }
+      console.log(`  Token:     ${data.local.token}`);
+    } else {
+      console.log(`  API:       ${data.local.apiHost}`);
+      warning("  Could not get workspace info.");
+    }
+    console.log();
+  }
+
+  // Branch section (current branch when working on a branch)
+  if (data.branch) {
+    highlight("» Branch:");
+    console.log(`  Name:      ${data.branch.name}`);
+    console.log(`  ID:        ${data.branch.id}`);
+    if (data.branch.dashboardUrl) {
+      console.log(`  Dashboard: ${data.branch.dashboardUrl}`);
+    }
+    console.log(`  Token:     ${data.branch.token}`);
+    console.log();
+  } else if (data.project?.devMode === "branch") {
+    // Show message when in branch mode but no branch (on main or no git)
+    highlight("» Branch:");
+    if (!data.project.gitBranch) {
+      warning("  Git branch not detected. Switch to a git branch first.");
+    } else if (data.project.isMainBranch) {
+      warning("  On main branch. Switch to a feature branch first.");
+    }
+    console.log();
+  }
+
+  // Project section
+  if (data.project) {
+    highlight("» Project:");
+    console.log(`  Directory: ${data.project.cwd}`);
+    console.log(`  Config:    ${data.project.configPath}`);
+    console.log(`  Dev mode:  ${data.project.devMode}`);
+    if (data.project.gitBranch) {
+      console.log(`  Git:       ${data.project.gitBranch}${data.project.isMainBranch ? " (main)" : ""}`);
+    }
+    console.log();
+  }
+
+}
+
 /**
  * Output object containing all output functions
  */
@@ -319,4 +429,5 @@ export const output = {
   showDeploySuccess,
   showDeployFailure,
   showBranchInfo,
+  showInfo,
 };