Skip to Content

App Commands

All app-related commands are grouped under finqu app. Use them to create apps, link a local project to an app, manage releases and publishing, and forward realtime webhook events to your development server.

Typical Workflow

  1. Create a new app with finqu app create.
  2. Link your local project with finqu app link so later commands can resolve the app automatically.
  3. Inspect or update metadata with finqu app info and finqu app update.
  4. Release and publish when ready with finqu app release and finqu app publish.
  5. Forward webhook traffic locally with finqu app listen during development.

Working With Linked Apps

Commands that operate on an existing app accept --app-id <id>. If you omit it, the CLI uses the app linked in your configuration.


Create and Connect

finqu app create

Creates a new draft app and scaffolds a project directory.

finqu app create [name]
OptionDescriptionDefault
--name <name>App display name
--base-uri <uri>HTTP base URIhttp://localhost:3000
--install-endpoint <path>Install endpoint/api/install
--redirect-uri <uri>OAuth redirect URIhttp://localhost:3000/api/install/callback

Any missing values are prompted interactively.

Links the current project to an existing app.

finqu app link <appId>

This stores the app ID in your configuration so later commands can resolve it automatically.


Inspect and Update

finqu app list

Lists all your apps.

finqu app list

The output includes app ID, name, handle, status, and version. The currently linked app is marked with .

finqu app info

Shows details for a single app.

finqu app info
OptionDescription
--app-id <id>Target app ID

Displays name, handle, ID, publish status, version, client ID, redirect URIs, base URI, and version history.

finqu app update

Updates app configuration or listing data.

finqu app update
OptionDescription
--app-id <id>Target app ID
--configuration <json>Configuration as JSON string
--listing <json>Listing data as JSON string
--redirect-uri <uri>OAuth redirect URI; use | as a separator for multiple values
--locations <codes...>ISO country codes to restrict availability; omit for all locations

finqu app delete

Deletes an app.

finqu app delete
OptionDescription
--app-id <id>Target app ID

Draft apps are deleted immediately. Published apps are scheduled for deletion.


Release and Distribution

finqu app release

Creates a new app version.

finqu app release
OptionDescription
--app-id <id>Target app ID
--version <version>Explicit version in MAJOR.MINOR.PATCH format
--type <type>Version bump type: major, minor, or patch
--changelog <text>Release notes

finqu app publish

Publishes the app to the app store.

finqu app publish
OptionDescription
--app-id <id>Target app ID

finqu app unpublish

Removes the app from the app store.

finqu app unpublish
OptionDescription
--app-id <id>Target app ID

finqu app share

Gets or creates a share link for the app.

finqu app share
OptionDescription
--app-id <id>Target app ID

finqu app rotate-secret

Rotates the OAuth client secret.

finqu app rotate-secret
OptionDescription
--app-id <id>Target app ID

The CLI prints the new client secret after rotation.


Local Webhook Forwarding

finqu app listen

Connects to Finqu realtime webhooks and forwards event envelopes to a local URL.

finqu app listen
OptionDescriptionDefault
--url <url>Local webhook receiver URLhttp://localhost:3000/webhooks
--realtime-url <url>Realtime websocket URL override
--topic <topics...>Only forward matching topics; accepts space-separated or comma-separated values

This command requires authentication via finqu sign-in and handles graceful shutdown on SIGINT and SIGTERM.

Examples

# Forward all webhook events to the default local URL finqu app listen # Forward to a custom local URL finqu app listen --url http://localhost:4000/webhooks # Only forward specific topics finqu app listen --topic orders/create orders/activate # Override the realtime websocket endpoint finqu app listen --realtime-url wss://<realtime-domain>/ws/webhooks