FormKiQ CLI

Official binary releases for the FormKiQ CLI.

The FormKiQ CLI is a command-line tool for syncing, importing, migrating, and managing documents in FormKiQ environments. It supports local and S3-based file sync, watched directory uploads, CSV imports, DynamoDB metadata restore, OpenSearch sync and verification, bulk document operations, Amazon Comprehend imports, and data migration workflows.

This repository contains binary distributions only. Source code is not included in this repository.

Downloads

Download the latest release from the GitHub Releases page.

Platform packages use the following naming pattern:

Platform	Package
Linux AMD64	formkiq-cli-VERSION-linux-amd64.zip
macOS Apple Silicon	formkiq-cli-VERSION-darwin-arm64.zip
Windows AMD64	formkiq-cli-VERSION-windows-amd64.zip

After extracting the package, verify the executable:

fk --help

Requirements

Before using the CLI, confirm you have:

• A FormKiQ Core, Essentials, Advanced, or Enterprise installation.
• Access to the AWS account and Region where FormKiQ is deployed.
• AWS credentials or an AWS profile with permissions for the workflows you plan to run.
• The FormKiQ API URL and document table name, or permission for the CLI to discover them from CloudFormation.

FormKiQ Core is available at github.com/formkiq/formkiq-core.

Configure

Configure a FormKiQ profile before running document workflows.

Use an AWS named profile:

fk --configure \
  --aws-profile AWS_PROFILE \
  --region AWS_REGION \
  --app-environment FORMKIQ_APP_ENVIRONMENT

Use an attached AWS role, such as in AWS CloudShell:

fk --configure \
  --app-environment FORMKIQ_APP_ENVIRONMENT \
  --region AWS_REGION

Verify the connection:

fk --status

List configured profiles:

fk --show

Common Workflows

Sync a local directory:

fk --sync \
  --dir /documents \
  --siteId default \
  --recursive

Watch a directory and upload new or changed files:

fk --watch \
  --dir /documents \
  --siteId default \
  --recursive

Import documents from CSV:

fk --import-csv \
  --documents documents.csv \
  --site-id default

List document IDs:

fk --list-documents \
  --site-id default \
  --limit 1000

Run a dry run before deleting all data for a site:

fk --delete-site \
  --site-id SITE_ID \
  --dry-run

Documentation

For installation details, command examples, permissions, and troubleshooting, see the FormKiQ CLI documentation.

Support

Contact support@formkiq.com for help with FormKiQ CLI usage or installation.

License

The FormKiQ CLI can be used with the free FormKiQ Core distribution and with FormKiQ commercial offerings. Some CLI workflows may require features, permissions, or infrastructure that are only available in specific FormKiQ editions.