Skip to main content

CLI for AI-assisted PDF form filling via Simplicity Form-Filler API

Project description

simplicity-cli

CLI for AI-assisted PDF form filling through the Simplicity Form-Filler API.

Authentication

Set your API key before running commands:

export SIMPLICITY_AI_API_KEY="your_api_key"

Or save it once locally:

simplicity-cli --api-key "your_api_key"

You can also pass it explicitly:

simplicity-cli --api-key "your_api_key" status TASK_ID

Auth precedence:

  1. --api-key
  2. SIMPLICITY_AI_API_KEY
  3. saved local key (from simplicity-cli --api-key "...")

Quick start

Get a one-page CLI guide:

simplicity-cli help

Create and autofill from a local form PDF using text context:

simplicity-cli new \
  --form-file ./form.pdf \
  --context "Use applicant data from profile A."

Create and autofill using uploaded source documents:

simplicity-cli new \
  --form-file ./form.pdf \
  --source-file ./w2.pdf \
  --source-file ./drivers_license.pdf

Autofill an existing form:

simplicity-cli existing FORM_ID --context "Apply latest account details."

Check or wait on tasks:

simplicity-cli status TASK_ID
simplicity-cli wait TASK_ID

Command reference

For full syntax/examples at any time, run:

simplicity-cli help

new

Create a digital form from a PDF and run autofill.

Common usage:

simplicity-cli new --form-file ./form.pdf --context "Applicant data..."
simplicity-cli new --form-file ./form.pdf --source-file ./w2.pdf --source-file ./id.pdf
simplicity-cli new --form-url https://example.com/form.pdf --source-url https://example.com/source.pdf

Validation rules:

  • Exactly one of --form-file or --form-url is required.
  • You must provide at least one source via --source-file/--source-url or --context/--context-file.
  • --context and --context-file are mutually exclusive.
  • --instructions and --instructions-file are mutually exclusive.
  • --output cannot be used with --no-download.

Useful flags:

  • --no-wait returns immediately with a task ID.
  • --no-download skips PDF download after completion.
  • --output PATH writes downloaded output to a specific path.
  • --poll-interval-seconds and --max-wait-seconds control polling behavior.

existing

Autofill an existing form ID.

Common usage:

simplicity-cli existing FORM_ID --context "Use latest profile data"
simplicity-cli existing FORM_ID --context-file ./context.txt --output ./filled.pdf
simplicity-cli existing FORM_ID --no-wait --no-download

Validation rules:

  • FORM_ID is required.
  • --context and --context-file are mutually exclusive.
  • --instructions and --instructions-file are mutually exclusive.
  • --output cannot be used with --no-download.

status

Get current task details.

simplicity-cli status TASK_ID

wait

Poll until completion, failure, or timeout.

simplicity-cli wait TASK_ID --poll-interval-seconds 2 --max-wait-seconds 1800

Legacy aliases

Backward-compatible nested commands are still accepted:

  • simplicity-cli fill new ...
  • simplicity-cli fill existing ...
  • simplicity-cli task status ...
  • simplicity-cli task wait ...

Output modes

Human-readable output is default. Use strict JSON for scripts:

simplicity-cli --json status TASK_ID

In --json mode, each command writes exactly one JSON object.

Exit codes

  • 0: success
  • 2: usage/validation/auth missing
  • 3: auth rejected (401/403)
  • 4: API/request error
  • 5: task failed
  • 6: wait timeout
  • 7: download error

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simplicity_cli-0.1.1.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simplicity_cli-0.1.1-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file simplicity_cli-0.1.1.tar.gz.

File metadata

  • Download URL: simplicity_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for simplicity_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b3b4dfab4b6ded6653d77839f7a80ca26e5318b6f7c8b0a8e84d769e5365c8d4
MD5 3dd1455caacfc30bbb80be4f5e73e0e7
BLAKE2b-256 110c61fbe73936d5866c86ca9653ecf1bb83abb8048a9f1ab7253c700d2d63ec

See more details on using hashes here.

File details

Details for the file simplicity_cli-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for simplicity_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b7e27a30c08abd11b58eabc9646ea9561b70ade734f887033947ba495fd9b0e9
MD5 96cd16e4218906ec636c26a2f3c33b4d
BLAKE2b-256 fa7740d05c463386f4b22b061301decce2ae921302cb17e0881dd237f3c190b0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page