oai-workbench-cli 0.1.0__py3-none-any.whl

oai_workbench_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,369 @@
+Metadata-Version: 2.4
+Name: oai-workbench-cli
+Version: 0.1.0
+Summary: Developer-first CLI wrapper around the official OpenAI Python SDK.
+Author: oai-cli contributors
+License: MIT
+License-File: LICENSE
+Keywords: cli,developer-tools,openai,rich,typer
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Requires-Python: <3.13,>=3.10
+Requires-Dist: jsonschema>=4.22.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: platformdirs>=4.2.0
+Requires-Dist: pydantic>=2.6.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: tomli>=2.0.1; python_version < '3.11'
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.5.0; extra == 'dev'
+Requires-Dist: types-jsonschema>=4.24.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# oai-cli
+
+Developer-first CLI for the OpenAI API, built on top of the official `openai-python` SDK.
+
+`oai-cli` is designed for day-to-day engineering work: quick prompts, dry-run payload inspection, local request logs, model comparisons, JSON schema validation, file and batch helpers, prompt linting, redaction, and AI-assisted review workflows from pipes.
+
+## Highlights
+
+- One-shot prompts with the Responses API: `oai-cli ask`
+- Interactive streaming chat REPL: `oai-cli chat`
+- Safe payload previews with `--dry-run`
+- Local SQLite request history, replay, export, and secret scanning
+- Local redaction for API keys, bearer tokens, JWTs, emails, phone numbers, cookies, private keys, and tokenized URLs
+- Prompt linting without API calls
+- Model comparison and eval runs across multiple models
+- Strict JSON mode with JSON Schema validation
+- Files and Batch API helpers
+- Pipe-friendly code review and traceback explanation commands
+- Profiles that store environment variable names, not plaintext API keys
+
+## Requirements
+
+- Python `3.10`, `3.11`, or `3.12`
+- An OpenAI API key exported through an environment variable
+
+Python `3.13+` is intentionally not advertised yet because several upstream dependencies may be unstable there.
+
+## Installation
+
+From PyPI:
+
+```bash
+pip install oai-workbench-cli
+```
+
+The installed console command is still `oai-cli`.
+
+For isolated CLI installation:
+
+```bash
+pipx install oai-workbench-cli
+```
+
+From a local checkout:
+
+```bash
+cd /path/to/oai-cli
+pip install .
+```
+
+For development:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Quickstart
+
+```bash
+export OPENAI_API_KEY=...
+
+oai-cli config init
+oai-cli doctor --check-api
+oai-cli ask --no-stream "Reply with OK only."
+oai-cli ask --dry-run "Explain this payload"
+```
+
+Fish shell:
+
+```fish
+set -gx OPENAI_API_KEY 'your_key_here'
+oai-cli doctor --check-api
+```
+
+Do not paste API keys into issues, chats, shell history, or committed files.
+
+## Global Options
+
+Global options must appear before the command:
+
+```bash
+oai-cli --timeout 30 ask "Reply briefly"
+oai-cli --plain doctor
+oai-cli --json doctor
+oai-cli --debug ask "Show traceback for expected CLI errors"
+```
+
+`--debug` can show tracebacks. Use it locally and avoid sharing output that may include sensitive data.
+
+## Configuration
+
+Initialize config:
+
+```bash
+oai-cli config init
+oai-cli config show
+```
+
+Default config paths:
+
+- Linux/macOS: `~/.config/oai-cli/config.toml`
+- Windows: platform app config directory via `platformdirs`
+
+The CLI stores the name of the environment variable, not the API key value.
+
+Profiles:
+
+```bash
+oai-cli profile list
+oai-cli profile create work --api-key-env OPENAI_WORK_API_KEY --model gpt-4.1
+oai-cli profile use work
+oai-cli profile show
+oai-cli profile delete work
+```
+
+Supported config fields:
+
+- `default_model`
+- `api_key_env`
+- `base_url`
+- `organization`
+- `project`
+- `log_enabled`
+- `log_path`
+- `redact_enabled`
+- `active_profile`
+- `profiles`
+
+## Ask
+
+```bash
+oai-cli ask "Explain Python context managers"
+cat prompt.txt | oai-cli ask --model gpt-4.1-mini
+oai-cli ask --system "You are concise." --temperature 0.2 "Summarize this"
+oai-cli ask --dry-run "Show request payload only"
+oai-cli ask --cost-estimate "Estimate input cost"
+```
+
+Key options:
+
+- `--model`, `-m`
+- `--system`
+- `--temperature`
+- `--max-output-tokens`
+- `--stream / --no-stream`
+- `--json`
+- `--dry-run`
+- `--cost-estimate`
+- `--save / --no-save`
+- `--redact / --no-redact`
+
+## Chat
+
+```bash
+oai-cli chat --model gpt-4.1-mini
+```
+
+REPL commands:
+
+```text
+/help
+/exit
+/clear
+/model <name>
+/system <text>
+/save <name>
+/load <name>
+/history
+```
+
+For multiline input, enter `"""`, then type lines, then close with `"""`.
+
+## Redaction
+
+```bash
+oai-cli redact "Bearer abcdef1234567890"
+cat file.txt | oai-cli redact
+cat file.txt | oai-cli redact --json
+```
+
+Redaction is local. It detects common secrets including OpenAI keys, JWTs, bearer tokens, GitHub tokens, generic API keys, cookies, private key PEM blocks, emails, phone numbers, and query-string tokens.
+
+## Logs And Replay
+
+```bash
+oai-cli logs list
+oai-cli logs show <id>
+oai-cli logs export --format jsonl
+oai-cli logs scan-secrets
+oai-cli replay <id> --dry-run
+oai-cli replay <id> --model gpt-4.1 --yes
+```
+
+Logs are stored in SQLite under the platform data directory unless `log_path` is configured.
+
+## Compare
+
+```bash
+oai-cli compare "Summarize this release note" -m gpt-4.1-mini -m gpt-4.1
+oai-cli compare --dry-run "Show payload only" -m gpt-4.1-mini -m gpt-4.1
+oai-cli compare "Prompt" -m gpt-4.1-mini -m gpt-4.1 --diff
+oai-cli compare "Prompt" -m gpt-4.1-mini -m gpt-4.1 --json-output result.json
+```
+
+## Prompt Lint
+
+```bash
+oai-cli prompt-lint prompt.txt
+cat prompt.txt | oai-cli prompt-lint --json
+```
+
+The linter is local-only and reports:
+
+- score from `0` to `100`
+- warnings
+- suggestions
+- improved prompt draft
+
+It checks for vague wording, missing output format, missing constraints, conflicting instructions, overly long prompts, hidden requirements, possible secrets, and JSON requests without schema.
+
+## JSON Mode
+
+```bash
+oai-cli json "Extract invoice fields" --schema schema.json
+oai-cli json "Extract invoice fields" --schema schema.json --retry 2 --output result.json
+oai-cli json "Show payload" --schema schema.json --dry-run
+```
+
+The command validates the schema locally, asks the model for JSON-only output, parses the response, and validates it against the schema before printing or writing it.
+
+## Files
+
+```bash
+oai-cli files list
+oai-cli files upload data.jsonl --purpose batch
+oai-cli files retrieve file_...
+oai-cli files delete file_...
+oai-cli files download file_... --output out.bin
+```
+
+## Batch
+
+```bash
+oai-cli batch create requests.jsonl --endpoint /v1/responses --completion-window 24h
+oai-cli batch create requests.jsonl --dry-run
+oai-cli batch status batch_...
+oai-cli batch list
+oai-cli batch cancel batch_...
+oai-cli batch download batch_... --output result.jsonl
+```
+
+`batch create` validates JSONL locally, shows row count, and previews the first row before upload.
+
+## Models
+
+```bash
+oai-cli models list --refresh
+oai-cli models cache
+oai-cli models list
+```
+
+`models list` uses the local cache unless `--refresh` is passed or no cache exists.
+
+## Eval
+
+Create a JSONL file:
+
+```jsonl
+{"id":"case-1","prompt":"Summarize this in one sentence: ..."}
+{"id":"case-2","prompt":"Extract the company name: ..."}
+```
+
+Run it:
+
+```bash
+oai-cli eval cases.jsonl -m gpt-4.1-mini -m gpt-4.1 --output eval-results.json
+oai-cli eval cases.jsonl -m gpt-4.1-mini --dry-run
+```
+
+## Code Review
+
+```bash
+git diff | oai-cli code-review
+git diff | oai-cli code-review --focus security --output json
+git diff | oai-cli code-review --dry-run
+```
+
+Redaction is enabled before sending the diff.
+
+## Explain Error
+
+```bash
+pytest 2>&1 | oai-cli explain-error
+pytest 2>&1 | oai-cli explain-error --dry-run
+```
+
+Redaction is enabled before sending logs.
+
+## Doctor
+
+```bash
+oai-cli doctor
+oai-cli doctor --check-api
+oai-cli doctor --json
+```
+
+Checks Python version, package version, SDK version, active profile, API key environment variable, base URL, config/log directories, and optionally a minimal API request.
+
+## Exit Codes
+
+- `0`: success
+- `1`: general error
+- `2`: config error
+- `3`: API error
+- `4`: validation error
+
+## Security Notes
+
+- API keys are read from environment variables.
+- API key values are not printed in dry-run output.
+- API keys are not stored in config by default.
+- Redaction is enabled by default for sensitive workflows.
+- If a key is pasted into a chat, issue, PR, terminal transcript, or committed file, revoke it and create a new one.
+
+## Development
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+
+ruff check openai_py_cli tests
+pytest
+mypy openai_py_cli
+```

oai_workbench_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,35 @@
+openai_py_cli/__init__.py,sha256=TbSN46sra_u4sSlaiXNqi6Iy-wcy5V0xQtYb8I22m5Y,93
+openai_py_cli/cli.py,sha256=nBY6L_s6gGskcnheTpPb-iYRFOFZtPxc7P82mcH7LcY,2094
+openai_py_cli/client.py,sha256=0vP1AAA4bjXLBBz-gwuMeaM8J-2BWZWC8qLOIvLyIU0,1330
+openai_py_cli/config.py,sha256=HkR7lO-_9C2Lg1AJPXWDrqjetCZIR1KqJeTfkAFTjAA,4591
+openai_py_cli/dry_run.py,sha256=2VUPalDUCh2xLxJHGbBB4zlOcqvqRCvNXieZCCCtCmk,648
+openai_py_cli/errors.py,sha256=YFba3GJtvuCrALktuZWniR1Lx8LdLP0h70YpP3KhS3s,842
+openai_py_cli/logging_store.py,sha256=-rJ83N2XoJmyKlH32t_GZwCMhdEqwGN-RNEUkUR0rQY,5387
+openai_py_cli/output.py,sha256=n252oYDP7J8YjOqPF_x2qZTl1zrXAABaOoJJMcGHlLM,895
+openai_py_cli/pricing.py,sha256=-Jjwk0-uQMb06ZmfXkGGdZ97EIXP5aMxE67meU-qQas,949
+openai_py_cli/redaction.py,sha256=LNbGsPESipD_kuQQ1nBiVn6nZOBgrgyaFoaoWurA_f4,2176
+openai_py_cli/runtime.py,sha256=5gmNHmZOKPGwGkj-iPYArYW-TJ9ejjnz8m2fqcWz_ns,286
+openai_py_cli/schema_validation.py,sha256=5x_2k4zdPRJYJfJjiwc8sBCDq_2zRlMUddGarROy3Bo,2328
+openai_py_cli/commands/__init__.py,sha256=gQ6tnU0Rvm0-ESWFUBU-KDl5dpNOpUTG509hXOQQjwY,27
+openai_py_cli/commands/ask.py,sha256=UAh0VloX5s7vJ4dKg6uzUxb6cvhP41-x7Cefi_BEtRU,6776
+openai_py_cli/commands/batch.py,sha256=zi6RT7rtfIyZFdoq8K61rETVAaoXuarLWT7EzuzNFlo,4034
+openai_py_cli/commands/chat.py,sha256=moIus0rdhEhBO0z84BBVnBgp35lGcZtlh38hMKmOKwg,4099
+openai_py_cli/commands/code_review.py,sha256=WRTMtiVOnQoI0HoLNtzHBvr6_UH1AINxAJ8sM9dnRoU,2609
+openai_py_cli/commands/compare.py,sha256=rFbhzMkKAs8ACwGMxL5pDmJcSH8Dlps0q3FIIwthwX8,6229
+openai_py_cli/commands/config_cmd.py,sha256=EWe0EXgoodIM121j1sSizL3pVMvBvrkYeAI4Ph0ryHA,1672
+openai_py_cli/commands/doctor.py,sha256=sBzqgLmMMZi2hkm5YEs34NLW7b0En7_2wwXRQzm4mP8,3015
+openai_py_cli/commands/eval_cmd.py,sha256=Ss2g42Wk-x0aQNUA6tw9uEkSfKit1y9fdvfb3iAotNk,4800
+openai_py_cli/commands/explain_error.py,sha256=nmk9ldSidfKWOse7nvqy2M2CP2aGq-fa3FbmiLVKeDE,1946
+openai_py_cli/commands/files.py,sha256=ORkHwz4TNxbmyqzeSAbuUFx-bjVz-ln1hOKdu_T89CU,3259
+openai_py_cli/commands/json_mode.py,sha256=e7Kjj7aX9gSi8MPm_BaAnx03nsXqPyXD-XlOvrR1q_Q,3580
+openai_py_cli/commands/logs.py,sha256=dAStj_Lqi2pie6ktDXp5X2i3mqbDiNjEyUFWibXbtdk,3738
+openai_py_cli/commands/models.py,sha256=wBcLZfxB017C-WC3rcJe-TMclRPYRetbqM3ou60VXn4,2279
+openai_py_cli/commands/profile.py,sha256=Xe--7LhSkRfBoGSq30-EPrVwauwqUSwc4WxB38ZlH-A,2789
+openai_py_cli/commands/prompt_lint.py,sha256=L98l34q6W-8TPpHnyX0fcm-w1pRh0gIrpSc7aBFyqec,6445
+openai_py_cli/commands/redact.py,sha256=Wo6ZPJM-hgrcjJfsp64Vgz3caThEqGqB8-BUGr8c37Y,705
+openai_py_cli/commands/replay.py,sha256=iUSDq40VVR-gaQUppTC_pVllYQv0S2gFUehcD2zEvYs,3677
+oai_workbench_cli-0.1.0.dist-info/METADATA,sha256=fprIhSuebjxFW_5i48IgtBYnuRaIQFUf82GGRHrYyfY,9009
+oai_workbench_cli-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+oai_workbench_cli-0.1.0.dist-info/entry_points.txt,sha256=tYWXFjcXFw6Zi2kBXKKSyC_qm6WMGk_eUvNJznsXU1c,51
+oai_workbench_cli-0.1.0.dist-info/licenses/LICENSE,sha256=icMQscwmqK97s-GnHAPKemnGXteId1Bc4fa31KM6hvA,1079
+oai_workbench_cli-0.1.0.dist-info/RECORD,,

oai_workbench_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

oai_workbench_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+oai-cli = openai_py_cli.cli:main

oai_workbench_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 openai-py contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openai_py_cli/__init__.py

@@ -0,0 +1,3 @@
+"""Developer-first CLI wrapper for the official OpenAI Python SDK."""
+
+__version__ = "0.1.0"

openai_py_cli/cli.py

@@ -0,0 +1,82 @@
+"""CLI entrypoint."""
+
+from __future__ import annotations
+
+import sys
+
+import typer
+
+from .commands import (
+    ask,
+    batch,
+    chat,
+    code_review,
+    compare,
+    config_cmd,
+    doctor,
+    eval_cmd,
+    explain_error,
+    files,
+    json_mode,
+    logs,
+    models,
+    profile,
+    prompt_lint,
+    redact,
+    replay,
+)
+from .errors import OpenAIPyCliError
+from .output import print_error
+from .runtime import options
+
+app = typer.Typer(
+    name="oai-cli",
+    help="Developer-first CLI wrapper around the official OpenAI Python SDK.",
+    no_args_is_help=True,
+    rich_markup_mode="rich",
+)
+
+
+@app.callback()
+def global_options(
+    debug: bool = typer.Option(False, "--debug", help="Show traceback for expected errors."),
+    timeout: float | None = typer.Option(None, "--timeout", help="OpenAI request timeout seconds."),
+    plain: bool = typer.Option(False, "--plain", help="Prefer plain text for machine parsing."),
+    json_output: bool = typer.Option(False, "--json", help="Prefer JSON for global errors."),
+) -> None:
+    options.debug = debug
+    options.timeout = timeout
+    options.plain = plain
+    options.json_output = json_output
+
+app.command("ask")(ask.ask)
+app.command("redact")(redact.redact)
+app.command("doctor")(doctor.doctor)
+app.command("replay")(replay.replay)
+app.command("compare")(compare.compare)
+app.command("prompt-lint")(prompt_lint.prompt_lint)
+app.command("chat")(chat.chat)
+app.command("json")(json_mode.json_command)
+app.command("code-review")(code_review.code_review)
+app.command("explain-error")(explain_error.explain_error)
+app.command("eval")(eval_cmd.eval_command)
+app.add_typer(files.app, name="files")
+app.add_typer(batch.app, name="batch")
+app.add_typer(logs.app, name="logs")
+app.add_typer(profile.app, name="profile")
+app.add_typer(config_cmd.app, name="config")
+app.add_typer(models.app, name="models")
+
+
+def main() -> None:
+    try:
+        app()
+    except OpenAIPyCliError as exc:
+        if options.debug:
+            raise
+        print_error(str(exc))
+        sys.exit(exc.exit_code)
+
+
+if __name__ == "__main__":
+    main()

openai_py_cli/client.py

@@ -0,0 +1,50 @@
+"""OpenAI SDK client creation."""
+
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from typing import Any
+
+from .config import AppConfig, Profile, load_config
+from .errors import MissingApiKeyError
+from .runtime import options
+
+
+@dataclass(frozen=True)
+class ClientContext:
+    config: AppConfig
+    profile_name: str
+    profile: Profile
+    api_key_env: str
+    api_key_present: bool
+
+
+def get_client(config: AppConfig | None = None) -> Any:
+    context = get_client_context(config)
+    api_key = os.environ.get(context.api_key_env)
+    if not api_key:
+        raise MissingApiKeyError(
+            f"{context.api_key_env} is not set. Run: export {context.api_key_env}=..."
+        )
+    from openai import OpenAI
+
+    return OpenAI(
+        api_key=api_key,
+        base_url=context.profile.base_url,
+        organization=context.profile.organization,
+        project=context.profile.project,
+        timeout=options.timeout,
+    )
+
+
+def get_client_context(config: AppConfig | None = None) -> ClientContext:
+    cfg = config or load_config()
+    profile = cfg.active()
+    return ClientContext(
+        config=cfg,
+        profile_name=cfg.active_profile,
+        profile=profile,
+        api_key_env=profile.api_key_env,
+        api_key_present=bool(os.environ.get(profile.api_key_env)),
+    )

openai_py_cli/commands/__init__.py

@@ -0,0 +1 @@
+"""CLI command modules."""