Forge FSQL CLI


Interactive CLI for querying Atlassian Forge SQL databases via web triggers.

Demo

!demo

Features

- 🎨 Table formatting with colors
- ⚡ Special commands (.tables, .describe, .schema)
- ⌨️ Command history (↑/↓ arrows)
- 💾 Persistent history across sessions
- ⏱️ 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

Installation

$3

`sh
npm install -g forge-fsql

fsql-setup
`

Notes:

- creates a webtrigger in your manifest.yml
- creates a module at src/fsql.ts for the webtrigger function
- deploys the project with the new manifest
- creates the webtrigger with forge webtrigger create (default environment which is DEVELOPMENT in a standard setup)
- adds the webtrigger URL to a FORGE_SQL_WEBTRIGGER environment variable in .env

Run

`sh
fsql
`

Upgrade

`sh


upgrade the CLI

> npm install -g forge-fsql@latest

run the setup from the root of your project to pick up the new version

it will install fsql.ts again and redeploy again

myforgeproject> fsql-setup
``