Quill CLI

Command-line tool for managing Quill BI metadata: dashboards, reports, virtual tables (schemas), and environment configuration.

The CLI talks to the Quill API. Cloud deployments use Quill's hosted API; self-hosted deployments point at your own query endpoint.

Requirements

• Node.js 18+

Installation

From this directory:

npm install
npm run build

Link the quill binary globally:

npm link

Quick start

1. Initialize configuration in your project directory:

quill init \
  --client-id <your-client-id> \
  --api-token <your-api-token> \

Settings are saved to .quill/config.json in the current working directory.

2. Verify the connection:

quill env show

Append --help to any command for full option details:

quill report create --help

Configuration

Common settings

| Key | Description | |-----|-------------| | clientId | Environment public key used for API requests | | token | API authentication token | | queryEndpoint | Base URL for the Quill query API (e.g. https://api.example.com/v1/sdk) | | serverUrl | Base URL for auth endpoints (token refresh) | | enableAdminCommands | When true, enables init and promote commands |

Sandbox workflow

By default, the CLI operates in a sandbox environment so changes are staged before promotion to production.

• On each command, the CLI automatically initiates or resumes a sandbox session tied to your configured clientId.
• Staged changes are tracked per session. View them with:

quill env status

• When enableAdminCommands is enabled, promote staged changes to the parent environment:

quill promote --confirm

• Discard the active sandbox without promoting:

quill promote --discard