> ## Documentation Index > Fetch the complete documentation index at: https://docs.runpulse.com/llms.txt > Use this file to discover all available pages before exploring further. # Command reference > Every Pulse CLI command, flag, and workflow. All commands share a few conventions: * `--json` switches any command to raw, pipe-safe JSON on stdout. * `--no-wait` submits async work and prints the `job_id` instead of polling; resume with [`pulse jobs get`](#pulse-jobs). * `--api-key` overrides the stored credential for one invocation (also read from the `PULSE_API_KEY` environment variable). * `-h` after any command prints its full options. ## pulse extract Convert documents to markdown and JSON. Accepts any mix of file paths, directories (recursed for supported types), and URLs. ```bash theme={null} pulse extract report.pdf pulse extract ./contracts -o ./results pulse extract https://example.com/10k.pdf --pages "1-15" --chunking semantic ``` Each input produces `.pulse.md` and `.pulse.json` next to the source file (`-o ` redirects; URL inputs land in the current directory). The output always includes the `extraction_id` you'll need for follow-up commands. Add `--schema` to run extraction and structured output as one pipeline; the structured fields are written to `.pulse.schema.json`: ```bash theme={null} pulse extract invoice.pdf --schema schemas/invoice.json pulse extract invoice.pdf --schema '{"type":"object","properties":{"total":{"type":"number"}}}' ``` | Flag | Description | | -------------------------------- | ----------------------------------------------------------- | | `--schema ` | Extract, then apply this JSON Schema for structured output. | | `--pages "1-2,5"` | Page range, 1-indexed. | | `--model ` | Model override: `default` or `pulse-ultra-2`. | | `--html` | Also return an HTML rendition. | | `--footnotes` | Link footnote markers to their text. | | `--figure-descriptions` | Caption figures and visuals. | | `--show-images` | Return image URLs for visuals. | | `--chunking semantic,page` | Chunk types: `semantic`, `header`, `page`, `recursive`. | | `--chunk-size ` | Max characters per chunk. | | `-o, --output ` | Directory for result files. | | `--no-wait` | Submit and print the `job_id` without polling. | | `--json` | Print the full JSON result to stdout; write no files. | Files up to 50 MB upload directly. Pass larger documents by URL. See [supported file types](/api-reference/supported-file-types). ## pulse schema Structured extraction against a *previous* extraction. (To extract and structure in one command, use `pulse extract --schema` above.) ### pulse schema generate AI-draft a JSON Schema from a plain-English description, or refine an existing one: ```bash theme={null} pulse schema generate -p "vendor name, line items, total due" -o invoice.json pulse schema generate --from invoice.json -p "also capture the PO number" ``` | Flag | Description | | --------------------- | --------------------------------------------- | | `-p, --prompt ` | Describe the fields you want. | | `--from ` | Existing schema JSON file to refine. | | `-o, --output ` | Write the schema to a file (default: stdout). | ### pulse schema apply Run a schema against extracted content: ```bash theme={null} pulse schema apply --schema invoice.json pulse schema apply --extraction-ids id1,id2 --schema combined.json pulse schema apply --split-id --split-schema-config per-topic.json ``` | Flag | Description | | ------------------------------ | ------------------------------------------------------------- | | `--schema ` | JSON Schema file. | | `-p, --prompt ` | Extra extraction guidance (works with or without `--schema`). | | `--extraction-ids a,b,c` | Combine several extractions. | | `--split-id ` | Apply per-topic schemas to a split. | | `--split-schema-config ` | Per-topic schema mapping (with `--split-id`). | | `--schema-config-id ` | Use a schema config saved in the platform. | | `--effort` | Higher-effort extraction. | | `--pages "1-3"` | Restrict to a page range. | | `-o, --output ` | Write result JSON to a file (default: stdout). | ## pulse split Split a prior extraction into sections by topic: ```bash theme={null} pulse split \ -t "introduction:opening section" \ -t "financials:tables and figures" ``` | Flag | Description | | -------------------------------- | ----------------------------------------- | | `-t, --topic "name:description"` | Repeatable; description optional. | | `--topics-file ` | JSON file: `[{name, description}, ...]`. | | `--split-config-id ` | Use a split config saved in the platform. | Returns per-topic page ranges and content. The resulting `split_id` feeds `pulse schema apply --split-id` for per-topic structured extraction. ## pulse tables Pull tables out of a prior extraction: ```bash theme={null} pulse tables --format html pulse tables -f json --merge --charts-to-tables ``` | Flag | Description | | ------------------------- | -------------------------------------- | | `-f, --format html\|json` | Table output format (default: `html`). | | `--merge` | Merge tables that span pages. | | `--charts-to-tables` | Convert charts into tables too. | | `-o, --output ` | Write result JSON to a file. | ## pulse jobs Every long-running command runs async under the hood and polls for you. Hand control back with `--no-wait`, or press Ctrl-C while polling (the job keeps running server-side), and resume any time: ```bash theme={null} pulse jobs get # one-shot status (and result when complete) pulse jobs get --watch # poll until the job is terminal pulse jobs cancel # cancel a pending or processing job ``` ## pulse usage Plan and usage for the current billing period: pages used vs. allowance, plus a breakdown by source (documents, pages, latency): ```bash theme={null} pulse usage pulse usage --days 7 pulse usage --json ``` ## pulse open Jump from the terminal to the platform: ```bash theme={null} pulse open # view an extraction pulse open # open the dashboard ``` ## pulse login / whoami / logout ```bash theme={null} pulse login # browser device flow (default) pulse login --api-key # log in with a key directly pulse whoami # active key (redacted), engine URL, connectivity pulse logout # remove the stored key ``` Credential precedence on every command: 1. `--api-key ` flag 2. `PULSE_API_KEY` environment variable (recommended for CI) 3. Stored credential from `pulse login` (OS keychain) Treat your API key like a password. In CI, inject `PULSE_API_KEY` from your secret store rather than writing keys into scripts. `pulse login --base-url ` points the CLI at a different engine (for example a VPC deployment). ## Interactive mode * Bare `pulse` starts an interactive shell with the full command set and inline help. * `pulse dashboard` opens a full-screen account and usage view. ## Scripting and output * Human-readable progress goes to the terminal; `--json` makes stdout pure JSON, so `pulse extract report.pdf --json | jq .markdown` just works. * File-writing commands echo every path they write plus the `extraction_id`. * Exit codes: `0` success, `1` failure (any document in a batch failing), `130` interrupted (job still running server-side). ```bash theme={null} # CI example: fail the step if extraction fails, keep the artifact export PULSE_API_KEY="$PULSE_KEY_FROM_SECRETS" pulse extract spec.pdf --json > spec.pulse.json ``` ## Troubleshooting Run `pulse whoami` to see which credential is active and where it came from. A flag or `PULSE_API_KEY` overrides the stored key, so a stale environment variable is the usual culprit. Re-run `pulse login` to refresh the stored key. You passed `--no-wait` or interrupted polling. The job is still running server-side: `pulse jobs get --watch` picks it back up. `pulse usage` talks to the platform API rather than the extraction engine. Re-run `pulse login` (browser flow configures both), or set the platform URL with `pulse login --platform-url https://platform.runpulse.com`. Direct uploads cap at 50 MB. Host the document somewhere reachable (a pre-signed S3 URL works) and pass the URL to `pulse extract`. Your plan limit was reached. Check `pulse usage`, upgrade in the [platform](https://platform.runpulse.com), or [contact support](mailto:support@trypulse.ai). ## Next steps Install, login, and when to use the CLI. The endpoints behind every command.