forge-fsql 1.2.0 → 1.3.0

package/README.md

@@ -1,5 +1,7 @@
 # Forge FSQL CLI
 
+[![NPM Package](https://img.shields.io/npm/v/forge-fsql.svg?style=flat-square)](https://www.npmjs.org/package/forge-fsql)
+
 Interactive CLI for querying Atlassian Forge SQL databases via web triggers.
 
 ## Demo
@@ -15,6 +17,27 @@ Interactive CLI for querying Atlassian Forge SQL databases via web triggers.
 - ⏱️ Query timing
 - 📝 Multi-line SQL support
 
+## Built in Commands
+
+```sh
+fsql> .help
+
+Special Commands:
+  .schema         Show database schema
+  .tables         List all tables
+  .describe       Describe a table (.describe table_name)
+  .indexes        Show all indexes
+  .migrations     List all migrations
+  .database       Show the database name
+  .help           Show available commands
+
+Other:
+  exit, quit      Exit the CLI
+  Ctrl+C          Cancel current query
+  Ctrl+D          Exit the CLI
+  ↑/↓             Navigate command history
+```
+
 ## Security
 
 - Disabled in Production - returns a 403 error if you attempt to call it

package/dist/cjs/commands.js

@@ -8,6 +8,14 @@ exports.parseCommand = parseCommand;
 const formatter_js_1 = require("./formatter.js");
 const chalk_1 = __importDefault(require("chalk"));
 exports.specialCommands = [
+    {
+        name: ".schema",
+        description: "Show database schema",
+        execute: async (client) => {
+            const result = await client.execute("SELECT table_name, column_name, data_type FROM information_schema.columns WHERE table_schema = DATABASE() ORDER BY table_name, ordinal_position");
+            return formatter_js_1.ResultFormatter.formatResult(result);
+        },
+    },
     {
         name: ".tables",
         description: "List all tables",
@@ -28,10 +36,26 @@ exports.specialCommands = [
         },
     },
     {
-        name: ".schema",
-        description: "Show database schema",
+        name: ".indexes",
+        description: "Show all indexes",
         execute: async (client) => {
-            const result = await client.execute("SELECT table_name, column_name, data_type FROM information_schema.columns WHERE table_schema = DATABASE() ORDER BY table_name, ordinal_position");
+            const result = await client.execute("SELECT TABLE_NAME, INDEX_NAME, COLUMN_NAME, SEQ_IN_INDEX, NON_UNIQUE FROM information_schema.STATISTICS WHERE TABLE_SCHEMA = DATABASE() ORDER BY CASE WHEN TABLE_NAME = '__migrations' THEN 1 ELSE 0 END, TABLE_NAME, INDEX_NAME, SEQ_IN_INDEX");
+            return formatter_js_1.ResultFormatter.formatResult(result);
+        },
+    },
+    {
+        name: ".migrations",
+        description: "List all migrations",
+        execute: async (client) => {
+            const result = await client.execute("SELECT * FROM __migrations");
+            return formatter_js_1.ResultFormatter.formatResult(result);
+        },
+    },
+    {
+        name: ".database",
+        description: "Show the database name",
+        execute: async (client) => {
+            const result = await client.execute("SHOW DATABASES");
             return formatter_js_1.ResultFormatter.formatResult(result);
         },
     },

package/dist/cjs/index.js

@@ -56,7 +56,7 @@ class ForgeSqlCli {
         const url = config.url || process.env.FORGE_SQL_WEBTRIGGER;
         if (!url) {
             console.error(chalk_1.default.red("Error: FORGE_SQL_WEBTRIGGER not configured"));
-            console.error(chalk_1.default.yellow("Set it via environment variable or .env file"));
+            console.error("Try rerunning 'fsql-setup'.\n\nSee the Installation docs at https://github.com/chatch/forge-fsql?tab=readme-ov-file#installation");
             process.exit(1);
         }
         this.client = new client_js_1.ForgeClient({

package/dist/commands.js

@@ -1,6 +1,14 @@
 import { ResultFormatter } from "./formatter.js";
 import chalk from "chalk";
 export const specialCommands = [
+    {
+        name: ".schema",
+        description: "Show database schema",
+        execute: async (client) => {
+            const result = await client.execute("SELECT table_name, column_name, data_type FROM information_schema.columns WHERE table_schema = DATABASE() ORDER BY table_name, ordinal_position");
+            return ResultFormatter.formatResult(result);
+        },
+    },
     {
         name: ".tables",
         description: "List all tables",
@@ -21,10 +29,26 @@ export const specialCommands = [
         },
     },
     {
-        name: ".schema",
-        description: "Show database schema",
+        name: ".indexes",
+        description: "Show all indexes",
         execute: async (client) => {
-            const result = await client.execute("SELECT table_name, column_name, data_type FROM information_schema.columns WHERE table_schema = DATABASE() ORDER BY table_name, ordinal_position");
+            const result = await client.execute("SELECT TABLE_NAME, INDEX_NAME, COLUMN_NAME, SEQ_IN_INDEX, NON_UNIQUE FROM information_schema.STATISTICS WHERE TABLE_SCHEMA = DATABASE() ORDER BY CASE WHEN TABLE_NAME = '__migrations' THEN 1 ELSE 0 END, TABLE_NAME, INDEX_NAME, SEQ_IN_INDEX");
+            return ResultFormatter.formatResult(result);
+        },
+    },
+    {
+        name: ".migrations",
+        description: "List all migrations",
+        execute: async (client) => {
+            const result = await client.execute("SELECT * FROM __migrations");
+            return ResultFormatter.formatResult(result);
+        },
+    },
+    {
+        name: ".database",
+        description: "Show the database name",
+        execute: async (client) => {
+            const result = await client.execute("SHOW DATABASES");
             return ResultFormatter.formatResult(result);
         },
     },

package/dist/index.js

@@ -15,7 +15,7 @@ export class ForgeSqlCli {
         const url = config.url || process.env.FORGE_SQL_WEBTRIGGER;
         if (!url) {
             console.error(chalk.red("Error: FORGE_SQL_WEBTRIGGER not configured"));
-            console.error(chalk.yellow("Set it via environment variable or .env file"));
+            console.error("Try rerunning 'fsql-setup'.\n\nSee the Installation docs at https://github.com/chatch/forge-fsql?tab=readme-ov-file#installation");
             process.exit(1);
         }
         this.client = new ForgeClient({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "forge-fsql",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "type": "module",
   "description": "Interactive SQL CLI for Atlassian Forge SQL via web triggers",
   "main": "dist/cjs/index.js",