aiex-cli 0.0.1 → 0.0.2-beta.10

package/README.md

@@ -21,7 +21,7 @@ npm install -g aiex-cli
 ```
 
 ```bash
-aiex web                                # configure schemas and AI settings in the browser
+aiex web                                # configure schemas, AI, integrations, and inspect data
 aiex schema                             # generate SQLite from JSON Schema files
 aiex extract -s invoice -f invoice.pdf  # extract data with AI and insert into database
 ```
@@ -31,10 +31,12 @@ aiex extract -s invoice -f invoice.pdf  # extract data with AI and insert into d
 ## ✨ Features
 
 - **JSON Schema → SQLite** — Define tables as JSON Schema files, generate Drizzle ORM schema, and migrate to SQLite
-- **Visual Editor** — Browser-based UI for designing schemas without writing JSON by hand
+- **Web Configuration & Viewer** — Browser-based UI for designing schemas, configuring integrations, previewing prompts, and browsing extracted data
 - **AI Extraction** — Extract structured data from text, images, and PDFs using any OpenAI-compatible provider (OpenAI, Anthropic, Ollama, DeepSeek, local models, etc.)
 - **Interactive Mode** — Run `aiex extract` without arguments for a guided extraction workflow
 - **Batch Mode** — `aiex extract -d <dir>` processes entire directories with optional glob filtering
+- **Notion Sync** — Optionally sync CLI extraction results to configured Notion data sources
+- **Extraction Audit Trail** — Every extraction is recorded with status, input source, output path, token usage, database inserts, Notion pages, and errors
 - **Built-in Model Registry** — Knows capabilities of 2000+ models (vision, structured output) so you don't have to guess
 
 <br>
@@ -47,7 +49,7 @@ aiex extract -s invoice -f invoice.pdf  # extract data with AI and insert into d
 aiex web
 ```
 
-Opens a browser UI where you can visually design and manage your schemas, configure AI settings, preview extraction prompts, and apply changes to the database.
+Opens a browser UI where you can visually design and manage your schemas, configure AI and integrations, preview extraction prompts, browse inserted SQLite data, inspect extracted JSON files, and apply schema changes to the database. Extraction itself runs from the CLI.
 
 ### 2. Generate Database
 
@@ -64,8 +66,13 @@ aiex extract                              # interactive mode (prompts for schema
 aiex extract -s <schema> -f <file>        # from file (txt, pdf, png, jpg, ...)
 aiex extract -s <schema> -t <text>        # from text
 aiex extract -s <schema> -f <file> -m <model>     # specify AI model (overrides auto-selection)
+aiex extract -s <schema> -f <file> --no-insert    # extract and save JSON without inserting into SQLite
 aiex extract -s <schema> -d <directory>           # batch extract all supported files in a directory
 aiex extract -s <schema> -d <dir> -g "*.pdf"      # batch with glob filter
+aiex extract history                              # list extraction audit records
+aiex extract show <audit-id>                      # show full audit record JSON
+aiex extract retry <audit-id>                     # retry a previous extraction
+aiex extract rm <audit-id>                        # delete an audit record and cached upload
 ```
 
 The AI reads your document and outputs structured JSON matching your schema.
@@ -74,13 +81,17 @@ The AI reads your document and outputs structured JSON matching your schema.
 ```bash
 aiex extract                                      # interactive mode
 aiex extract -s paper -f research.pdf              # save result to .aiex/extracted/ and insert into database
+aiex extract -s paper -f research.pdf --no-insert   # save result only, skip database insert
 aiex extract -s paper -f research.pdf -m gpt-4o    # use a specific model
 aiex extract -s paper -d ./papers -g "*.pdf"        # batch extract PDFs from a directory
+aiex extract history                                # inspect recent extraction runs
 ```
 Saves the extracted result to `.aiex/extracted/<schema-name>-<timestamp>.json` with fields like `title`, `firstAuthor`, `journal`, `year` — exactly as defined in your schema. Data is automatically inserted into the SQLite database.
 
 By default, aiex automatically selects a model based on your input type (vision-capable for images, structured output for text). Use `--model` / `-m` to override and specify any model from your AI configuration.
 
+Every extraction is also recorded under `.aiex/extracted/_audit/`. Audit records include the run status (`running`, `succeeded`, `failed`, or `stale`), schema name, input source, output file, token usage, inserted table rows, synced Notion pages, retry lineage, and error message. Deleting an audit record removes its cached upload, but keeps extracted JSON result files to avoid accidental data loss.
+
 <br>
 
 ## 📖 Commands
@@ -89,12 +100,18 @@ By default, aiex automatically selects a model based on your input type (vision-
 | --- | --- |
 | `aiex schema` | Parse JSON Schema files and migrate to SQLite |
 | `aiex schema --generate` | Generate Drizzle schema code only (skip migration) |
-| `aiex web` | Launch visual schema editor in browser |
+| `aiex web` | Launch visual schema/configuration UI and data viewer in browser |
 | `aiex extract` | Interactive mode — prompts for schema and input source |
 | `aiex extract -s <name> -f <file>` | Extract structured data from documents and insert into SQLite database |
 | `aiex extract -s <name> -f <file> -m <model>` | Extract with a specific AI model |
+| `aiex extract -s <name> -f <file> --no-insert` | Extract and save JSON without inserting into SQLite |
 | `aiex extract -s <name> -d <dir>` | Batch extract all supported files in a directory |
 | `aiex extract -s <name> -d <dir> -g "*.pdf"` | Batch extract with glob filter |
+| `aiex extract history` | List extraction audit records |
+| `aiex extract show <audit-id>` | Show a full extraction audit record |
+| `aiex extract retry <audit-id>` | Retry a previous extraction run |
+| `aiex extract retry <audit-id> --no-insert` | Retry without inserting into SQLite |
+| `aiex extract rm <audit-id>` | Delete an audit record and its cached upload |
 | `aiex doctor` | System and configuration diagnostics |
 | `aiex completion bash\|zsh\|fish` | Generate shell completion scripts |
 
@@ -126,6 +143,7 @@ aiex works with any OpenAI-compatible API provider. Configure in the Web UI (AI
 - **Provider** — Set your base URL and API key
 - **Models** — Add models with vision and/or structured output capabilities
 - **Prompts** — Customize system and user prompt templates with `{schema}` and `{text}` placeholders
+- **Integrations** — Optionally connect Notion from AI Settings; use Connect & Map to bind a schema to an existing Notion data source
 
 The built-in model registry automatically suggests capabilities for 2000+ models from providers including OpenAI, Anthropic, Google, Meta, Mistral, DeepSeek, Alibaba Cloud, and more.