Fulcrum Desktop Reference

Command reference for Fulcrum Desktop.

Usage

OS Command
macOS / Linux fulcrum <cmd> [args]
Windows .\fulcrum.cmd <cmd> [args]

Options

Option Description Type
--version Show version number [boolean]
--help Show help [boolean]

Commands

All command line arguments are also configurable via environment variables, prefixed with FULCRUM_. e.g. setting --home-path from an environment variable using FULCRUM_HOME_PATH. Explicit CLI arguments win. e.g. fulcrum setup --home-path <path> (to set the file system location for data, config, plugins, etc.); required for setup, sync, and install-plugin if not set as an environment variable.

setup

Setup the local Fulcrum database. Requires that the API token belong to an account owner.

Note: setup by default is run interactively on Linux/macOS, via prompts for email/password. Windows requires passing email/password parameters.

Option Description Required Default
--org organization name true na
--email email associated with your Fulcrum account true true
--password password for your Fulcrum account true true
--token <token> skip email/password and use an API token false false
OS Command
macOS / Linux fulcrum setup
Windows .\fulcrum.cmd setup --email EMAIL --password SECRET

sync

Sync an organization to the local database. Defaults to a one-time sync, but can continually sync (10 second intervals) using the --forever option.

Option Description Required Default
--org organization name true na
--forever keep the sync running forever false false
--clean start a clean sync, all data will be deleted before starting false false
--after-sync-command <command> run an arbitrary command after each sync false false
--no-progress disable progress logs, automatically disabled if stdout isn’t a tty false false
--simple-output replace emoji-based status indicators with text-based false false
--no-colors disable console colors, automatically disabled for dumb terminals false false
--form <id> filter by form ID, use multiple --form params for multiple forms false false
OS Command
macOS / Linux fulcrum sync --org 'Organization Name'
Windows .\fulcrum.cmd sync --org "Organization Name"

Windows seems to prefer double quotes with command parameters.

reset

Reset an organization.

OS Command
macOS / Linux fulcrum reset --org 'Organization Name'
Windows .\fulcrum.cmd reset --org "Organization Name"

install-plugin

Install a plugin.

Option Description Required Default
--name the plugin name false na
--url the URL to a git repo false false
OS Command
macOS / Linux fulcrum install-plugin --url https://github.com/fulcrumapp/fulcrum-desktop-postgres
Windows .\fulcrum.cmd install-plugin --url https://github.com/fulcrumapp/fulcrum-desktop-postgres

create-plugin

Create a new plugin.

Option Description Required Default
--name the new plugin name true na
OS Command
macOS / Linux fulcrum create-plugin --name 'MyPlugin'
Windows .\fulcrum.cmd create-plugin --name "MyPlugin"

update-plugins

Update all plugins.

OS Command
macOS / Linux fulcrum update-plugins
Windows .\fulcrum.cmd update-plugins

build-plugins

Build all plugins.

OS Command
macOS / Linux fulcrum build-plugins
Windows .\fulcrum.cmd build-plugins

watch-plugins

Watch and recompile all plugins.

Option Description Required Default
--name plugin name to watch false na
OS Command
macOS / Linux fulcrum watch-plugins
Windows .\fulcrum.cmd watch-plugins

query

Run a query in the local database.

Option Description Required Default
--sql sql query true na
OS Command
macOS / Linux fulcrum query --sql 'SELECT COUNT(*) FROM memberships'
Windows .\fulcrum.cmd query --sql "SELECT COUNT(*) FROM memberships"