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.

API target

The CLI uses a hardcoded API base URL:

  • https://api.simplicity.ai

Authentication

Set your API key before running commands:

export SIMPLICITY_AI_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

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

new

Create a digital form from a PDF and run autofill.

simplicity-cli new \
  (--form-file PATH | --form-url URL) \
  [--source-file PATH ...] \
  [--source-url URL ...] \
  [--context TEXT | --context-file PATH] \
  [--instructions TEXT | --instructions-file PATH] \
  [--no-wait] \
  [--poll-interval-seconds 2] \
  [--max-wait-seconds 1800] \
  [--no-download] \
  [--output PATH]

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.

existing

Autofill an existing form ID.

simplicity-cli existing FORM_ID \
  [--context TEXT | --context-file PATH] \
  [--instructions TEXT | --instructions-file PATH] \
  [--no-wait] \
  [--poll-interval-seconds 2] \
  [--max-wait-seconds 1800] \
  [--no-download] \
  [--output PATH]

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.0.tar.gz (15.0 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.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for simplicity_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 44b4b9e2f214fa91d46116716e6dc033e4641c5b8eac366e6a7fd5bc99f4f765
MD5 8cfacc1a5c69d3403b552d35a36570fe
BLAKE2b-256 71ad809c23e12a1ac776a8c05392845fe274301b724ef4a94d45ba976ffc33ac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for simplicity_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d766128993ef19722f81c993899f0a249a8e2708a760ffa3943d6580d4ec880a
MD5 9bb6d14c90d5e0740152e0590ac7e79c
BLAKE2b-256 40e296a66a7444a589f5ffc25ed70ce31de8fe1f8f41d687281743f13af6071d

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