Skip to content

commands.md

Latest commit

 

History

History
181 lines (117 loc) · 2.71 KB

commands.md

File metadata and controls

181 lines (117 loc) · 2.71 KB

Commands reference

Complete reference for all formseal-fetch commands.

Usage syntax

fsf <command> [options] [arguments]

Commands

connect

Connect to a storage backend.

fsf connect <name> [field:value]...

Arguments:

Argument Description
<name> Storage provider — available: cloudflare, supabase, redis
field:<value> Provider-specific fields (see provider docs)

Examples:

# Interactive mode — you'll be prompted for all required values
fsf connect <name>

# Non-interactive — all values provided via arguments
fsf connect <name> field:<value> field:<value>

Press Ctrl+C at any prompt to cancel.

fetch

Download ciphertexts from your connected backend.

fsf fetch [--output <path>] [--debug]

Options:

Option Description
--output Custom output file path (default: <output_folder>/formseal.ct.jsonl)
--debug Show full error tracebacks for debugging

Examples:

# Use default output folder
fsf fetch

# Custom output file
fsf fetch --output my-data.jsonl

# Debug mode (detailed errors)
fsf fetch --debug

Deduplication:

If you run fsf fetch multiple times, duplicates are automatically skipped based on ciphertext content. The output shows:

  • Number of new ciphertexts saved
  • Number of duplicates skipped

status

Show current connection status and configuration.

fsf status

Output includes:

  • Provider name and display name
  • Provider-specific fields (from config)
  • Token status and storage location
  • Output folder path

disconnect

Clear all credentials and configuration.

fsf disconnect
fsf disconnect --wipe

What it removes:

  • Provider configuration
  • API token (from OS Keychain or secrets.json)
  • Provider-specific fields (from OS Keychain or secrets.json)
  • Configuration file

What it does NOT remove (disconnect only):

  • Downloaded ciphertexts in your output folder

--wipe flag:

fsf disconnect --wipe

This removes everything above PLUS the ciphertexts file.

providers

List available storage backends.

fsf providers

--help

Show help information.

fsf --help

--version

Show version number.

fsf --version
fsf version

--aliases

Show shorthand aliases.

fsf --aliases

Lists all available shorthand flags:

Short Canonical
-s status
-c connect <name>
-o fetch --output <path>
-p providers

--about

Show project information.

fsf --about