Install the CLI

Install ft, the official FreeTicket command-line tool, and run your first commands.

ft is the official FreeTicket CLI. It calls the B2B API and gives you your events, sales, tickets, memberships, venues, staff and reports from the terminal. Output is a readable table, or JSON and CSV for scripts.

The CLI is generated from the API’s OpenAPI contract, so its parameters and enums match the API.

Requirements

• Node.js 20 or newer
• A FreeTicket account with access to a workspace

Install

npm install -g @freeticket/cli

pnpm add -g @freeticket/cli

npx @freeticket/cli@latest whoami

Check the install:

ft --version

Run ft with no arguments, or ft <command> --help, to see what is available.

First commands

ft login                               # browser login, no key to paste
ft whoami                              # your user and workspaces
ft events list                         # events across your workspaces
ft reports summary --period 30d        # KPIs for the last 30 days
ft sales list --status CONFIRMED --json

Configuration

ft resolves settings in this order:

flags  >  environment variables  >  ~/.freeticket/config.json  >  defaults

~/.freeticket/config.json holds your session, so the CLI keeps it at 0600 permissions (readable only by you). ft config shows the active configuration with the credential masked.

The update notice prints at most once a day, on stderr, and only in an interactive terminal.

Next