CLI reference

This page is generated from the same argparse definitions used by the installed parsehawk command. Change CLI help in code, run just references-export, and commit the updated page.

Exit status

Code	Meaning
0	Command completed successfully.
1	Runtime, API, configuration, validation, or local-environment failure.
2	Command-line usage error reported by argparse.

Errors are written to standard error. API failures include the HTTP status and response body; connection failures include the target API URL.

Command index

• parsehawk
• parsehawk start
• parsehawk dev
• parsehawk restart
• parsehawk stop
• parsehawk status
• parsehawk migrate
• parsehawk doctor
• parsehawk config
• parsehawk config list
• parsehawk config set
• parsehawk runtime
• parsehawk runtime info
• parsehawk runtime test
• parsehawk runtime doctor
• parsehawk extract
• parsehawk files
• parsehawk files list
• parsehawk files get
• parsehawk files upload
• parsehawk files delete
• parsehawk schemas
• parsehawk schemas validate
• parsehawk extractors
• parsehawk extractors list
• parsehawk extractors get
• parsehawk extractors create
• parsehawk extractors put
• parsehawk extractors update
• parsehawk extractors delete
• parsehawk providers
• parsehawk providers list
• parsehawk providers get
• parsehawk providers configure
• parsehawk providers models
• parsehawk jobs
• parsehawk jobs create
• parsehawk jobs list
• parsehawk jobs get
• parsehawk jobs delete

parsehawk

Run and operate the local-first ParseHawk document extraction platform.

$ parsehawk [-h] {start,dev,restart,stop,status,migrate,doctor,config,runtime,extract,files,schemas,extractors,providers,jobs} ...

Example

$ parsehawk --help

Related commands

• parsehawk config
• parsehawk dev
• parsehawk doctor
• parsehawk extract
• parsehawk extractors
• parsehawk files
• parsehawk jobs
• parsehawk migrate
• parsehawk providers
• parsehawk restart
• parsehawk runtime
• parsehawk schemas
• parsehawk start
• parsehawk status
• parsehawk stop

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk start

Start ParseHawk and its bundled services.

$ parsehawk start [-h] [--host HOST] [--port PORT] [--data-dir DATA_DIR] [--runtime-host RUNTIME_HOST] [--runtime-port RUNTIME_PORT] [--model MODEL] [-x COMPONENT] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--runtime-keep-alive-seconds RUNTIME_KEEP_ALIVE_SECONDS] [--web-host WEB_HOST] [--web-port WEB_PORT] [--no-web]

Example

$ parsehawk start

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--host HOST	API bind address.	No	127.0.0.1
--port PORT	API port.	No	8000
--data-dir DATA_DIR	Directory for the database, uploaded files, logs, and runtime state.	No	—
--runtime-host RUNTIME_HOST	Bundled model runtime bind address.	No	127.0.0.1
--runtime-port RUNTIME_PORT	Model runtime port.	No	8080
--model MODEL	Model identifier for the bundled runtime.	No	—
-x COMPONENT, --exclude COMPONENT	Skip a start-time component. Repeatable. Supports: migrate (database migrations), runtime (the bundled model runtime; use this to run against a configured cloud/remote provider instead), and phoenix (the bundled Phoenix tracing backend; also turns off LM request tracing unless OTEL_SDK_DISABLED is set explicitly). Choices: migrate, runtime, phoenix.	No	—
--log-level LOG_LEVEL	Set the log level for all ParseHawk services. Choices: DEBUG, INFO, WARNING, ERROR, CRITICAL.	No	—
--runtime-keep-alive-seconds RUNTIME_KEEP_ALIVE_SECONDS	Unload the model runtime after this many idle seconds. Use 0 to keep it loaded.	No	—
--web-host WEB_HOST	Web UI bind address.	No	127.0.0.1
--web-port WEB_PORT	Web UI port.	No	5173
--no-web	Do not start the web UI.	No	false

parsehawk dev

Run ParseHawk from the local source checkout.

$ parsehawk dev [-h] [--host HOST] [--port PORT] [--data-dir DATA_DIR] [--runtime-host RUNTIME_HOST] [--runtime-port RUNTIME_PORT] [--model MODEL] [-x COMPONENT] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--runtime-keep-alive-seconds RUNTIME_KEEP_ALIVE_SECONDS] [--reload] [--web-host WEB_HOST] [--web-port WEB_PORT] [--no-web]

Example

$ parsehawk dev --reload

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--host HOST	API bind address.	No	127.0.0.1
--port PORT	API port.	No	8000
--data-dir DATA_DIR	Directory for the database, uploaded files, logs, and runtime state.	No	—
--runtime-host RUNTIME_HOST	Bundled model runtime bind address.	No	127.0.0.1
--runtime-port RUNTIME_PORT	Model runtime port.	No	8080
--model MODEL	Model identifier for the bundled runtime.	No	—
-x COMPONENT, --exclude COMPONENT	Skip a start-time component. Repeatable. Supports: migrate (database migrations), runtime (the bundled model runtime; use this to run against a configured cloud/remote provider instead), and phoenix (the bundled Phoenix tracing backend; also turns off LM request tracing unless OTEL_SDK_DISABLED is set explicitly). Choices: migrate, runtime, phoenix.	No	—
--log-level LOG_LEVEL	Set the log level for all ParseHawk services. Choices: DEBUG, INFO, WARNING, ERROR, CRITICAL.	No	—
--runtime-keep-alive-seconds RUNTIME_KEEP_ALIVE_SECONDS	Unload the model runtime after this many idle seconds. Use 0 to keep it loaded.	No	—
--reload	Reload the API when Python source changes.	No	false
--web-host WEB_HOST	Web UI bind address.	No	127.0.0.1
--web-port WEB_PORT	Web UI port.	No	5173
--no-web	Do not start the web UI.	No	false

parsehawk restart

Restart ParseHawk and its bundled services.

$ parsehawk restart [-h] [--host HOST] [--port PORT] [--data-dir DATA_DIR] [--runtime-host RUNTIME_HOST] [--runtime-port RUNTIME_PORT] [--model MODEL] [-x COMPONENT] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--runtime-keep-alive-seconds RUNTIME_KEEP_ALIVE_SECONDS] [--web-host WEB_HOST] [--web-port WEB_PORT] [--no-web]

Example

$ parsehawk restart

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--host HOST	API bind address.	No	127.0.0.1
--port PORT	API port.	No	8000
--data-dir DATA_DIR	Directory for the database, uploaded files, logs, and runtime state.	No	—
--runtime-host RUNTIME_HOST	Bundled model runtime bind address.	No	127.0.0.1
--runtime-port RUNTIME_PORT	Model runtime port.	No	8080
--model MODEL	Model identifier for the bundled runtime.	No	—
-x COMPONENT, --exclude COMPONENT	Skip a start-time component. Repeatable. Supports: migrate (database migrations), runtime (the bundled model runtime; use this to run against a configured cloud/remote provider instead), and phoenix (the bundled Phoenix tracing backend; also turns off LM request tracing unless OTEL_SDK_DISABLED is set explicitly). Choices: migrate, runtime, phoenix.	No	—
--log-level LOG_LEVEL	Set the log level for all ParseHawk services. Choices: DEBUG, INFO, WARNING, ERROR, CRITICAL.	No	—
--runtime-keep-alive-seconds RUNTIME_KEEP_ALIVE_SECONDS	Unload the model runtime after this many idle seconds. Use 0 to keep it loaded.	No	—
--web-host WEB_HOST	Web UI bind address.	No	127.0.0.1
--web-port WEB_PORT	Web UI port.	No	5173
--no-web	Do not start the web UI.	No	false

parsehawk stop

Stop managed ParseHawk services.

$ parsehawk stop [-h] [--data-dir DATA_DIR]

Example

$ parsehawk stop

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--data-dir DATA_DIR	Data directory containing the managed process state.	No	—

parsehawk status

Show the status and URLs of managed ParseHawk services.

$ parsehawk status [-h] [--data-dir DATA_DIR]

Example

$ parsehawk status

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--data-dir DATA_DIR	Data directory containing the managed process state.	No	—

parsehawk migrate

Apply pending database migrations or show their status.

$ parsehawk migrate [-h] [--data-dir DATA_DIR] [--json] [{status}]

Example

$ parsehawk migrate status

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
[migrate_command]	Use ‘status’ to show applied/pending migrations instead of applying them. Choices: status.	No	—
--data-dir DATA_DIR	Data directory containing the database.	No	—
--json	Print machine-readable migration status.	No	false

parsehawk doctor

Check the local ParseHawk installation and services.

$ parsehawk doctor [-h] [--json] [--api-url API_URL] [--web-url WEB_URL] [--runtime-url RUNTIME_URL] [--data-dir DATA_DIR]

Example

$ parsehawk doctor --json

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--json	Print machine-readable check results.	No	false
--api-url API_URL	API URL to check.	No	—
--web-url WEB_URL	Web UI URL to check.	No	—
--runtime-url RUNTIME_URL	Model runtime URL to check.	No	—
--data-dir DATA_DIR	Data directory to inspect.	No	—

parsehawk config

Inspect or update persistent ParseHawk CLI configuration.

$ parsehawk config [-h] {list,set} ...

Example

$ parsehawk config --help

Related commands

• parsehawk
• parsehawk config list
• parsehawk config set

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk config list

List effective CLI configuration values.

$ parsehawk config list [-h] [--json]

Example

$ parsehawk config list --json

Related commands

• parsehawk config

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--json	Print configuration as JSON.	No	false

parsehawk config set

Persist one CLI configuration value.

$ parsehawk config set [-h] key value

Example

$ parsehawk config set log.level DEBUG

Related commands

• parsehawk config

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
key	Configuration key to update.	Yes	—
value	String value to persist.	Yes	—

parsehawk runtime

Inspect and test the configured model runtime.

$ parsehawk runtime [-h] {info,test,doctor} ...

Example

$ parsehawk runtime --help

Related commands

• parsehawk
• parsehawk runtime doctor
• parsehawk runtime info
• parsehawk runtime test

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk runtime info

Show the effective model runtime URL and model.

$ parsehawk runtime info [-h] [--runtime-url RUNTIME_URL] [--model MODEL] [--json]

Example

$ parsehawk runtime info --json

Related commands

• parsehawk runtime

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--runtime-url RUNTIME_URL	Override the configured runtime URL.	No	—
--model MODEL	Override the configured model identifier.	No	—
--json	Print runtime information as JSON.	No	false

parsehawk runtime test

Send a minimal chat completion to the model runtime.

$ parsehawk runtime test [-h] [--runtime-url RUNTIME_URL] [--model MODEL] [--json]

Example

$ parsehawk runtime test

Related commands

• parsehawk runtime

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--runtime-url RUNTIME_URL	Override the configured runtime URL.	No	—
--model MODEL	Override the configured model identifier.	No	—
--json	Print the runtime response as JSON.	No	false

parsehawk runtime doctor

Run model-runtime connectivity and model checks.

$ parsehawk runtime doctor [-h] [--runtime-url RUNTIME_URL] [--model MODEL] [--json]

Example

$ parsehawk runtime doctor --json

Related commands

• parsehawk runtime

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--runtime-url RUNTIME_URL	Override the configured runtime URL.	No	—
--model MODEL	Override the configured model identifier.	No	—
--json	Print machine-readable check results.	No	false

parsehawk extract

Run a one-shot extraction and optionally wait for its result.

$ parsehawk extract [-h] [--extractor EXTRACTOR] [--schema SCHEMA] [--instructions INSTRUCTIONS] [--name NAME] [--reasoning-effort {default,none,minimal,low,medium,high,xhigh}] [--file-id FILE_ID | --text TEXT | --text-file TEXT_FILE] [--wait] [--poll-seconds POLL_SECONDS] [--timeout-seconds TIMEOUT_SECONDS] [--output OUTPUT] [--api-url API_URL] [source]

Example

$ parsehawk extract tests/fixtures/receipt/receipt.jpg --extractor receipt --wait

Related commands

• parsehawk

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
[source]	Local document path, @path, file ID, or inline text.	No	—
--extractor EXTRACTOR	Extractor ID or stable name. Required unless –schema is used.	No	—
--schema SCHEMA	JSON Schema path for an ad hoc extractor.	No	—
--instructions INSTRUCTIONS	Inline instructions or a path used with an ad hoc extractor.	No	—
--name NAME	Display name for the ad hoc extractor.	No	—
--reasoning-effort REASONING_EFFORT	Reasoning effort for the ad hoc extractor; ‘default’ clears the override. Choices: default, none, minimal, low, medium, high, xhigh.	No	—
--file-id FILE_ID	Use an already uploaded file ID.	No	—
--text TEXT	Extract from this inline text.	No	—
--text-file TEXT_FILE	Extract from the contents of this text file.	No	—
--wait	Wait for completion and print the extraction result.	No	false
--poll-seconds POLL_SECONDS	Polling interval while waiting.	No	1.0
--timeout-seconds TIMEOUT_SECONDS	Maximum wait time.	No	600.0
--output OUTPUT	Write the result JSON to this path.	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk files

Upload, inspect, list, and delete source files.

$ parsehawk files [-h] {list,get,upload,create,delete} ...

Example

$ parsehawk files --help

Related commands

• parsehawk
• parsehawk files delete
• parsehawk files get
• parsehawk files list
• parsehawk files upload

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk files list

List uploaded files.

$ parsehawk files list [-h] [--api-url API_URL]

Example

$ parsehawk files list

Related commands

• parsehawk files

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk files get

Get file metadata by ID.

$ parsehawk files get [-h] [--api-url API_URL] file_id

Example

$ parsehawk files get file_...

Related commands

• parsehawk files

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
file_id	File ID.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk files upload

Upload a local source file.

Aliases: create

$ parsehawk files upload [-h] [--file FILE_PATH] [--api-url API_URL] [path]

Example

$ parsehawk files upload document.pdf

Related commands

• parsehawk files

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
[path]	Local file path; an optional leading @ is ignored.	No	—
--file FILE_PATH	Local file path, equivalent to the positional path.	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk files delete

Delete a file and its stored content.

$ parsehawk files delete [-h] [--api-url API_URL] file_id

Example

$ parsehawk files delete file_...

Related commands

• parsehawk files

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
file_id	File ID.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk schemas

Validate extraction JSON Schema drafts.

$ parsehawk schemas [-h] {validate} ...

Example

$ parsehawk schemas --help

Related commands

• parsehawk
• parsehawk schemas validate

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk schemas validate

Validate an extraction schema before saving it.

$ parsehawk schemas validate [-h] [--api-url API_URL] schema_path

Example

$ parsehawk schemas validate invoice.schema.json

Related commands

• parsehawk schemas

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
schema_path	Path to the JSON Schema file.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk extractors

Create, inspect, update, and delete reusable extractors.

$ parsehawk extractors [-h] {list,get,create,put,update,delete} ...

Example

$ parsehawk extractors --help

Related commands

• parsehawk
• parsehawk extractors create
• parsehawk extractors delete
• parsehawk extractors get
• parsehawk extractors list
• parsehawk extractors put
• parsehawk extractors update

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk extractors list

List reusable extractors.

$ parsehawk extractors list [-h] [--api-url API_URL]

Example

$ parsehawk extractors list

Related commands

• parsehawk extractors

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk extractors get

Get an extractor by ID or stable name.

$ parsehawk extractors get [-h] [--api-url API_URL] extractor_ref

Example

$ parsehawk extractors get invoice_v1

Related commands

• parsehawk extractors

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
extractor_ref	Extractor ID or stable name.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk extractors create

Create a reusable extractor.

$ parsehawk extractors create [-h] [--name NAME] [--display-name DISPLAY_NAME] --instructions INSTRUCTIONS --schema SCHEMA [--examples EXAMPLES] [--reasoning-effort {default,none,minimal,low,medium,high,xhigh}] [--provider {openai,microsoft_foundry,openai_compatible_api}] [--model MODEL] [--api-url API_URL]

Example

$ parsehawk extractors create --name invoice_v1 --display-name "Invoice extractor" --instructions instructions.txt --schema invoice.schema.json

Related commands

• parsehawk extractors

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--name NAME	Optional stable extractor name.	No	—
--display-name DISPLAY_NAME	Human-readable extractor name.	No	—
--instructions INSTRUCTIONS	Inline instructions or a text-file path.	Yes	—
--schema SCHEMA	Path to the extraction JSON Schema.	Yes	—
--examples EXAMPLES	Path to a JSON array of input/output examples.	No	—
--reasoning-effort REASONING_EFFORT	Reasoning effort override; ‘default’ clears the override. Choices: default, none, minimal, low, medium, high, xhigh.	No	—
--provider PROVIDER_NAME	Provider override for this extractor. Choices: openai, microsoft_foundry, openai_compatible_api.	No	—
--model MODEL	Provider model override.	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk extractors put

Create or fully replace an extractor by reference.

$ parsehawk extractors put [-h] [--name NAME] --display-name DISPLAY_NAME --instructions INSTRUCTIONS --schema SCHEMA [--examples EXAMPLES] [--reasoning-effort {default,none,minimal,low,medium,high,xhigh}] [--provider {openai,microsoft_foundry,openai_compatible_api}] [--model MODEL] [--api-url API_URL] extractor_ref

Example

$ parsehawk extractors put invoice_v1 --display-name "Invoice extractor" --instructions instructions.txt --schema invoice.schema.json

Related commands

• parsehawk extractors

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
extractor_ref	Extractor ID or stable name.	Yes	—
--name NAME	Stable extractor name.	No	—
--display-name DISPLAY_NAME	Human-readable extractor name.	Yes	—
--instructions INSTRUCTIONS	Inline instructions or a text-file path.	Yes	—
--schema SCHEMA	Path to the extraction JSON Schema.	Yes	—
--examples EXAMPLES	Path to a JSON array of input/output examples.	No	—
--reasoning-effort REASONING_EFFORT	Reasoning effort override; ‘default’ clears the override. Choices: default, none, minimal, low, medium, high, xhigh.	No	—
--provider PROVIDER_NAME	Provider override for this extractor. Choices: openai, microsoft_foundry, openai_compatible_api.	No	—
--model MODEL	Provider model override.	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk extractors update

Update selected fields on an extractor.

$ parsehawk extractors update [-h] [--display-name DISPLAY_NAME] [--instructions INSTRUCTIONS] [--schema SCHEMA] [--examples EXAMPLES] [--provider {openai,microsoft_foundry,openai_compatible_api}] [--model MODEL] [--reasoning-effort {default,none,minimal,low,medium,high,xhigh}] [--api-url API_URL] extractor_ref

Example

$ parsehawk extractors update invoice_v1 --display-name "Invoices"

Related commands

• parsehawk extractors

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
extractor_ref	Extractor ID or stable name.	Yes	—
--display-name DISPLAY_NAME	Human-readable extractor name.	No	—
--instructions INSTRUCTIONS	Inline instructions or a text-file path.	No	—
--schema SCHEMA	Path to the extraction JSON Schema.	No	—
--examples EXAMPLES	Path to a JSON array of input/output examples.	No	—
--provider PROVIDER_NAME	Provider override for this extractor. Choices: openai, microsoft_foundry, openai_compatible_api.	No	—
--model MODEL	Provider model override.	No	—
--reasoning-effort REASONING_EFFORT	Reasoning effort override; ‘default’ clears the override. Choices: default, none, minimal, low, medium, high, xhigh.	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk extractors delete

Delete an extractor by ID or stable name.

$ parsehawk extractors delete [-h] [--api-url API_URL] extractor_ref

Example

$ parsehawk extractors delete invoice_v1

Related commands

• parsehawk extractors

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
extractor_ref	Extractor ID or stable name.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk providers

Inspect and configure model providers.

$ parsehawk providers [-h] {list,get,configure,models} ...

Example

$ parsehawk providers --help

Related commands

• parsehawk
• parsehawk providers configure
• parsehawk providers get
• parsehawk providers list
• parsehawk providers models

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk providers list

List configured model providers.

$ parsehawk providers list [-h] [--api-url API_URL]

Example

$ parsehawk providers list

Related commands

• parsehawk providers

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk providers get

Get one provider configuration.

$ parsehawk providers get [-h] [--api-url API_URL] {openai,microsoft_foundry,openai_compatible_api}

Example

$ parsehawk providers get openai_compatible_api

Related commands

• parsehawk providers

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
name	Provider name. Choices: openai, microsoft_foundry, openai_compatible_api.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk providers configure

Set a provider base URL, provider configuration, or API key.

$ parsehawk providers configure [-h] [--base-url BASE_URL] [--project-url PROJECT_URL] [--api-key API_KEY] [--api-key-env API_KEY_ENV] [--api-url API_URL] {openai,microsoft_foundry,openai_compatible_api}

Example

$ parsehawk providers configure openai --api-key-env OPENAI_API_KEY

Related commands

• parsehawk providers

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
name	Provider name. Choices: openai, microsoft_foundry, openai_compatible_api.	Yes	—
--base-url BASE_URL	Provider API base URL; use an empty value to clear it.	No	—
--project-url PROJECT_URL	Microsoft Foundry project URL for deployment discovery.	No	—
--api-key API_KEY	API key to encrypt and store; use an empty value to clear it.	No	—
--api-key-env API_KEY_ENV	Read the API key from this environment variable and store it.	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk providers models

List models currently offered by a provider.

$ parsehawk providers models [-h] [--api-url API_URL] {openai,microsoft_foundry,openai_compatible_api}

Example

$ parsehawk providers models openai_compatible_api

Related commands

• parsehawk providers

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
name	Provider name. Choices: openai, microsoft_foundry, openai_compatible_api.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk jobs

Create, inspect, list, and delete extraction jobs.

$ parsehawk jobs [-h] {create,list,get,delete} ...

Example

$ parsehawk jobs --help

Related commands

• parsehawk
• parsehawk jobs create
• parsehawk jobs delete
• parsehawk jobs get
• parsehawk jobs list

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—

parsehawk jobs create

Create an asynchronous extraction job.

$ parsehawk jobs create [-h] [--extractor EXTRACTOR_ID_OPTION] (--file-id FILE_ID | --text TEXT | --text-file TEXT_FILE) [--api-url API_URL] [extractor_id]

Example

$ parsehawk jobs create invoice_v1 --text "Invoice A-204 · Total EUR 128.40"

Related commands

• parsehawk jobs

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
[extractor_id]	Extractor ID or stable name.	No	—
--extractor EXTRACTOR_ID_OPTION	Extractor ID or stable name.	No	—
--file-id FILE_ID, --file FILE_ID	Previously uploaded file ID.	One of group	—
--text TEXT	Inline source text.	One of group	—
--text-file TEXT_FILE	Path to a source text file.	One of group	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk jobs list

List extraction jobs.

$ parsehawk jobs list [-h] [--extractor-id EXTRACTOR_ID] [--api-url API_URL]

Example

$ parsehawk jobs list --extractor invoice_v1

Related commands

• parsehawk jobs

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
--extractor-id EXTRACTOR_ID, --extractor EXTRACTOR_ID	Filter by extractor ID or stable name.	No	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk jobs get

Get an extraction job by ID.

$ parsehawk jobs get [-h] [--api-url API_URL] job_id

Example

$ parsehawk jobs get job_...

Related commands

• parsehawk jobs

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
job_id	Job ID.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000

parsehawk jobs delete

Cancel a pending job or delete a finished job.

$ parsehawk jobs delete [-h] [--api-url API_URL] job_id

Example

$ parsehawk jobs delete job_...

Related commands

• parsehawk jobs

Argument	Description	Required	Default
-h, --help	show this help message and exit	No	—
job_id	Job ID.	Yes	—
--api-url API_URL	ParseHawk API URL; defaults to PARSEHAWK_API_URL when set.	No	http://127.0.0.1:8000