aiex-cli 0.0.0 → 0.0.1-beta.10

package/README.md

@@ -1,10 +1,10 @@
 <p align="center">
-  <a href="https://www.npmjs.com/package/aiex-cli"><img src="https://img.shields.io/npm/v/aiex?style=flat&colorA=18181B&colorB=green" alt="npm version"></a>
-  <a href="https://www.npmjs.com/package/aiex-cli"><img src="https://img.shields.io/npm/dm/aiex?style=flat&colorA=18181B&colorB=green" alt="npm downloads"></a>
+  <a href="https://www.npmjs.com/package/aiex-cli"><img src="https://img.shields.io/npm/v/aiex-cli?style=flat&colorA=18181B&colorB=green" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/aiex-cli"><img src="https://img.shields.io/npm/dm/aiex-cli?style=flat&colorA=18181B&colorB=green" alt="npm downloads"></a>
   <a href="https://github.com/OSpoon/aiex-cli/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green?style=flat&colorA=18181B&colorB=green" alt="license"></a>
 </p>
 
-<h1 align="center">aiex</h1>
+<h1 align="center">AIEX</h1>
 
 <p align="center">
   <b>JSON Schema → SQLite — with AI-powered data extraction</b>
@@ -21,9 +21,10 @@ npm install -g aiex-cli
 ```
 
 ```bash
-cd my-project && aiex schema --init   # set up your schema directory
-aiex schema "*.json"                   # generate SQLite from JSON Schema
-aiex extract -s invoice -f invoice.pdf # extract data with AI
+aiex schema --init                      # set up .aiex/schema/ directory
+aiex schema                             # generate SQLite from JSON Schema files
+aiex extract -s invoice -f invoice.pdf  # extract data with AI
+aiex extract -s invoice -f invoice.pdf --db  # extract and insert into database
 ```
 
 <br>
@@ -47,6 +48,8 @@ aiex schema --init
 
 Creates a `.aiex/` directory with example schemas to get you started.
 
+Add your own JSON Schema files to `.aiex/schema/` (one file per table), then run `aiex schema` to migrate them into the database.
+
 ### 2. Visual Editor
 
 ```bash
@@ -58,7 +61,7 @@ Opens a browser UI where you can visually design and manage your schemas, config
 ### 3. Generate Database
 
 ```bash
-aiex schema "*.json"
+aiex schema
 ```
 
 Converts your JSON Schema files into a SQLite database with full migration support.
@@ -66,17 +69,22 @@ Converts your JSON Schema files into a SQLite database with full migration suppo
 ### 4. Extract Data
 
 ```bash
-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>     # 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)
 ```
 
 The AI reads your document and outputs structured JSON matching your schema.
 
-**Example:**
+**Examples:**
 ```bash
-aiex extract -s paper -f research.pdf
+aiex extract -s paper -f research.pdf              # save result to .aiex/extracted/
+aiex extract -s paper -f research.pdf --db         # also insert into SQLite database
+aiex extract -s paper -f research.pdf -m gpt-4o    # use a specific model
 ```
-Creates `output.json` with fields like `title`, `firstAuthor`, `journal`, `year` — exactly as defined in your schema.
+Saves the extracted result to `.aiex/extracted/<schema-name>-<timestamp>.json` with fields like `title`, `firstAuthor`, `journal`, `year` — exactly as defined in your schema. Add `--db` to also insert the data directly 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.
 
 <br>
 
@@ -85,11 +93,33 @@ Creates `output.json` with fields like `title`, `firstAuthor`, `journal`, `year`
 | Command | Description |
 | --- | --- |
 | `aiex schema --init` | Scaffold `.aiex/` directory with example schemas |
-| `aiex schema <files>` | Parse JSON Schema files and migrate to SQLite |
+| `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 extract -s <name>` | Extract structured data from documents via AI |
+| `aiex extract -s <name> -f <file>` | Extract structured data from documents via AI |
+| `aiex extract -s <name> -f <file> --db` | Extract and insert into SQLite database |
+| `aiex extract -s <name> -f <file> -m <model>` | Extract with a specific AI model |
 | `aiex doctor` | System and configuration diagnostics |
+| `aiex completion bash\|zsh\|fish` | Generate shell completion scripts |
+
+### Shell Completions
+
+Enable tab completion for commands and options:
+
+```bash
+# bash
+source <(aiex completion bash)
+
+# zsh
+source <(aiex completion zsh)
+
+# fish
+aiex completion fish | source
+```
+
+To make it permanent, add the `source` line to your shell config file (`~/.bashrc`, `~/.zshrc`, or `~/.config/fish/config.fish`).
+
+> Completions are dynamically generated from the command definitions — no manual updates needed when commands or options change.
 
 <br>