pifang 0.1.0__tar.gz

pifang-0.1.0/.gitignore

@@ -0,0 +1,73 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/
+.pifang-tmp-*
+.pifang-*/
+
+# secrets / local env
+.env
+.env.*
+!.env.example
+
+# tooling caches
+.mypy_cache/
+.ruff_cache/
+.tox/
+
+# agent / roster / Cursor — local only, not part of the OSS package
+.claude/
+.cursor/
+.roster/
+.roster-backup*/
+.roster-manifest.json
+handoff/
+
+# OS / editor
+.DS_Store
+Thumbs.db
+*.swp
+
+# roster-generated (agent IP — regenerate with `roster deploy`, don't commit)
+**/.claude/agents/
+**/.claude/skills/
+**/.claude/references/
+**/.agents/skills/
+**/.cursor/rules/pm.mdc
+**/.cursor/rules/software-architect.mdc
+**/.cursor/rules/pkg-architect.mdc
+**/.cursor/rules/ai-architect.mdc
+**/.cursor/rules/brand-strategist.mdc
+**/.cursor/rules/copywriter.mdc
+**/.cursor/rules/designer.mdc
+**/.cursor/rules/developer.mdc
+**/.cursor/rules/pkg-developer.mdc
+**/.cursor/rules/devops.mdc
+**/.cursor/rules/pkg-devops.mdc
+**/.cursor/rules/server-admin.mdc
+**/.cursor/rules/docs-writer.mdc
+**/.cursor/rules/qa-reviewer.mdc
+**/.cursor/rules/experience-reviewer.mdc
+**/.cursor/rules/security-reviewer.mdc
+**/.cursor/rules/art-director.mdc
+**/.opencode/agents/
+**/opencode.json
+**/.hermes/agents/
+**/.hermes/README.md
+**/.codex/
+**/.zcode/agents/
+**/.grok/agents/
+**/.pi/agents/
+**/.kimi-code/agents/
+**/.roster-manifest.json
+**/.cadre-manifest.json
+
+# quickstart.py outputs
+examples/fixtures/avatar.webp
+examples/fixtures/out.webp
+examples/fixtures/batch-out/

pifang-0.1.0/.out-of-scope/README.md

@@ -0,0 +1,28 @@
+---
+for_agent: |
+  Institutional memory for "no." Before proposing a feature, scope expansion, or approach,
+  check here first — if an idea was already rejected, do NOT re-litigate it; cite the entry and
+  move on, or surface a NEW reason the decision should be revisited. Record each rejected request
+  as its own dated file: out-of-scope/<slug>.md with the request, why it was declined, and what
+  (if anything) would change the answer. Append; never delete an entry — a reversal supersedes it
+  with a new entry that links back. This is project-scoped benign context, not agent IP.
+for_human: |
+  The rejected-ideas log. When a feature, integration, or approach is deliberately ruled out, it
+  gets written here so the team stops re-proposing it across runs. Each entry says what was asked,
+  why it was declined, and what would have to change to reopen it. Read this before re-asking for
+  something that "feels missing" — it may be a settled "no" with a reason.
+---
+
+# Out of scope
+
+Documented rejected requests — institutional memory for "no."
+
+Agents check this folder before proposing a feature or approach; a settled "no" is cited, not
+re-litigated. Each rejected request is one dated file, `out-of-scope/<slug>.md`, capturing:
+
+- **The request** — what was asked, in the asker's words.
+- **Why declined** — the reason it's out of scope (cost, risk, strategy, sequencing).
+- **What would reopen it** — the condition under which the decision should be revisited.
+
+Entries are append-only: a reversal is a new entry that supersedes and links back to the old one,
+never a deletion. This is benign project context — it is not committed agent IP.

pifang-0.1.0/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — 2026-09-23
+
+First public-facing release line (git dogfood → OSS). Includes **v0.5 release hardening** before first PyPI upload.
+
+### Added
+
+- Image domain: atoms, recipes (`avatar`, `hero`, `social-square`), pipe DSL, batch + JSONL manifests, social/blog/podcast/video-cover packs, remove-bg / flatten-bg / recolor
+- Document domain: `doc convert` (markdown + images only), `doc ingest` (manifest + optional engine JSON), split/merge/extract-images/ocr, text chunk/frontmatter, meta index/validate
+- Default doc engine `fast` (pymupdf4llm); optional OpenDataLoader via `pifang[doc-odl]` + JDK
+- Video domain: ffmpeg-backed info/transcode/trim/extract-audio/concat/to-gif/extract-frames/resize/normalize-audio/captions + recipes; `pipe video` + `batch run video`
+- Transcribe: Faster-Whisper via `pifang[transcribe]`; timeline JSON + SRT (+ optional VTT); `video`/`audio` aliases
+- `pifang setup` for pip extras + printed system install hints (ffmpeg/Java)
+- Agent consumer docs: `docs/agents-blurb.md`, `skills/pifang/SKILL.md`
+- Root `--version` flag; leaf `--force` / `--dry-run` / `--verbose` on mutating commands
+- Subprocess timeouts; structured `SUBPROCESS_TIMEOUT` errors
+
+### Changed
+
+- **Plain text by default, `--json` for agents** — with `--json` (root or any subcommand) stdout is exactly one JSON object, success or failure; `--human` removed
+- Closed-set CLI params are real enums; pipe DSL rejects stray tokens (no silent stage drop)
+- Batch early-stop accounting: `total == succeeded + failed + skipped + not_attempted`; first error inlined; domain-correct `batch.{image|video}.*` labels
+- Skip-if-unchanged metadata reports the existing **output** file’s dimensions/bytes
+- sdist ships a curated docs list (no internal tasks/archive/publishing checklists)
+- README links are absolute GitHub URLs for PyPI rendering
+- Dropped redundant `License :: OSI Approved :: …` classifier (SPDX `license = "Apache-2.0"` is authoritative)
+
+### Fixed
+
+- Doc ingest stem sanitization for filenames with spaces (fast engine)
+- `ingest.jsonl` merge-by-input across runs; corrupt resume lines warn with line numbers
+- WebM transcode codec defaults (VP9/Opus)
+- Global exception fallback always emits the JSON error envelope (`INTERNAL`, exit 3)
+- First-class validation/processing errors for bad dimensions, unknown formats, bad fit color, decompression bombs, corrupt PDFs, bad manifest lines, malformed custom recipes
+- `image compress` crash when `--quality` ≤ 9 with `--max-kb`
+- ffmpeg concat/subtitles escaping for filenames containing `'`
+- Temp intermediates cleaned on failed multi-stage pipe/recipe runs
+- `remove-bg` / `recolor` use Pillow C-level ops (no pure-Python pixel loops)
+- Non-ASCII paths in JSON use `ensure_ascii=False`
+
+[0.1.0]: https://github.com/StormForgeVentures/pifang/releases/tag/v0.1.0

pifang-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,56 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes
+- Focusing on what is best for the overall community
+
+Examples of unacceptable behavior:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces and when an individual
+is officially representing the community in public spaces.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project maintainers at **hello@stormforgeventures.com**. All complaints will
+be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+[homepage]: https://www.contributor-covenant.org

pifang-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing to Pifang
+
+Thanks for helping improve an agent-first media CLI.
+
+## Development setup
+
+```bash
+git clone https://github.com/StormForgeVentures/pifang.git
+cd pifang
+uv venv && source .venv/bin/activate
+uv pip install -e ".[dev,doc,transcribe]"
+# optional system tools — printed, not auto-installed:
+pifang setup
+```
+
+Requires Python 3.11+.
+
+## Checks
+
+```bash
+pytest tests -q
+pifang doctor --doc --video --transcribe
+```
+
+Video/transcribe integration tests skip when `ffmpeg` or `faster-whisper` is missing.
+
+## Project layout
+
+- `src/pifang/` — library + CLI
+- `tests/` — pytest
+- `docs/` — product docs, glossary, agent blurb
+- `examples/` — quickstart + fixtures
+- `skills/pifang/` — optional Agent Skill drop-in for consumer projects
+
+## Pull requests
+
+1. Prefer a focused branch (`fix/…`, `feature/…`).
+2. Add/adjust tests for behavior changes.
+3. Keep the public CLI stable; widen surfaces only with docs updates.
+4. Run `pytest` before opening the PR.
+5. Fill out the PR template checklist.
+
+## Coding notes
+
+- Default stdout is plain text for terminals. With `--json`, stdout is exactly one JSON object — that is the agent contract and must stay stable.
+- Exit codes: 0 success · 1 validation · 2 missing dep · 3 processing · 4 partial batch.
+- Prefer extending atoms/recipes over one-off scripts in docs/examples.
+- Doc default engine is `fast` (pure Python). OpenDataLoader is opt-in (`doc-odl` + JDK).
+
+## License
+
+By contributing, you agree your contributions are licensed under the Apache License 2.0.

pifang-0.1.0/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 Tim Wolf
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pifang-0.1.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.5
+Name: pifang
+Version: 0.1.0
+Summary: Agent-first CLI for deterministic image, document, and media processing
+Project-URL: Homepage, https://github.com/StormForgeVentures/pifang
+Project-URL: Repository, https://github.com/StormForgeVentures/pifang
+Project-URL: Issues, https://github.com/StormForgeVentures/pifang/issues
+Project-URL: Changelog, https://github.com/StormForgeVentures/pifang/blob/main/CHANGELOG.md
+Author-email: StormForge Ventures <hello@stormforgeventures.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,batch,cli,ffmpeg,image,pdf,transcription,whisper
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.11
+Requires-Dist: click>=8.0.0
+Requires-Dist: pillow>=10.4.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.0; extra == 'dev'
+Requires-Dist: pymupdf4llm>=0.0.20; extra == 'dev'
+Requires-Dist: pypdf>=5.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: twine>=7.0.0; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: pymupdf4llm>=0.0.20; extra == 'doc'
+Requires-Dist: pypdf>=5.0.0; extra == 'doc'
+Provides-Extra: doc-heavy
+Requires-Dist: docling>=2.0.0; extra == 'doc-heavy'
+Requires-Dist: marker-pdf>=1.0.0; extra == 'doc-heavy'
+Provides-Extra: doc-odl
+Requires-Dist: opendataloader-pdf>=1.0.0; extra == 'doc-odl'
+Provides-Extra: fast
+Requires-Dist: pyvips>=2.2.0; extra == 'fast'
+Provides-Extra: transcribe
+Requires-Dist: faster-whisper>=1.0.0; extra == 'transcribe'
+Provides-Extra: video
+Description-Content-Type: text/markdown
+
+# Pifang
+
+[![CI](https://github.com/StormForgeVentures/pifang/actions/workflows/ci.yml/badge.svg)](https://github.com/StormForgeVentures/pifang/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/StormForgeVentures/pifang/blob/main/LICENSE)
+
+One CLI for the media chores that usually end up as one-off scripts: resize and convert images, export every social/blog/podcast size from one photo, turn PDFs into markdown, trim and transcode video, transcribe audio. Plain Python, runs locally, no cloud.
+
+Built so AI agents can drive it too: add `--json` and every command returns one JSON object with stable exit codes.
+
+## What it does
+
+| Domain | Commands |
+|---|---|
+| **Image** (core, Pillow) | `resize` `crop` `crop-square` `fit` `convert` `compress` `thumbnail` `strip-exif` `info` `analyze` · `remove-bg` `flatten-bg` `recolor` · recipes `avatar` `hero` `social-square` |
+| **Image packs** | `social-pack` (Instagram square/tall/story, Facebook, LinkedIn, X, YouTube…) · `blog-pack` (OG, hero, Medium, card) · `podcast-pack` (Apple/Spotify covers) · `video-cover-pack` · `custom-pack` (your own `WxH:slug` list) |
+| **Document** (`[doc]`) | `doc convert` PDF → markdown + images · `doc ingest` a folder → markdown + `ingest.jsonl` for RAG · `split` `merge` `extract-images` `ocr` `info` · `text chunk` `text frontmatter` · `meta index` `meta validate` |
+| **Video** (system ffmpeg) | `trim` `transcode` `resize` `concat` `to-gif` `extract-frames` `extract-audio` `normalize-audio` `captions` `info` · recipes `social-clip` `podcast-audio` |
+| **Transcribe** (`[transcribe]`) | `transcribe` any audio/video → `.transcript.json` + `.srt` (+ `.vtt`) with Faster-Whisper, local |
+| **Pipelines** | `pipe image "crop-square \| resize 512 \| to-webp q85"` · `pipe video "trim 0-30 \| resize 1080x1920 \| transcode"` · `batch run image\|video <command> ./folder/` with a JSONL manifest · custom YAML recipes |
+
+Every mutating command supports `--dry-run` and skips unchanged work; `pifang doctor` tells you which optional pieces are installed.
+
+## Install
+
+```bash
+uv tool install 'pifang[doc,transcribe]'
+# or
+pipx install 'pifang[doc,transcribe]'
+# or
+pip install 'pifang[doc,transcribe]'
+
+# guided extras (pip) + printed system commands for ffmpeg/Java
+pifang setup
+pifang setup --extras doc,transcribe --install
+```
+
+| Extra | What you get |
+|---|---|
+| *(core)* | Pillow image CLI |
+| `doc` | Pure-Python PDF path (default engine `fast`) |
+| `doc-odl` | Optional OpenDataLoader (needs JDK 11+) |
+| `doc-heavy` | marker + docling |
+| `transcribe` | Faster-Whisper |
+| `video` | Marker only — install system ffmpeg/ffprobe |
+| `fast` | optional pyvips |
+
+Default doc engine is pure-Python `fast`. OpenDataLoader is opt-in: `--engine opendataloader`.
+
+## Quickstart
+
+```bash
+# works on a bare install — no extras, no system deps
+pifang image avatar photo.jpg -o out/photo.webp --size 512
+pifang image social-pack photo.jpg -o ./social/
+pifang pipe image "crop-square | resize 512 | to-webp q85" photo.jpg -o out/photo.webp
+pifang batch run image convert ./photos/ -o ./photos-webp/ --format webp --manifest ingest.jsonl
+
+# check what the optional surfaces need
+pifang doctor --doc --video --transcribe
+
+pifang doc convert paper.pdf -o ./out/          # md + _images/ only
+pifang doc ingest ./corpus/ -o ./corpus-md/     # + ingest.jsonl
+
+pifang video trim clip.mp4 -o trim.mp4 --start 5 --duration 10
+pifang pipe video "trim start=0 duration=10 | transcode" clip.mp4 -o out.mp4
+pifang batch run video transcode ./clips/ -o ./out/ --format mp4
+pifang transcribe clip.mp4 -o ./out/            # .transcript.json + .srt
+```
+
+Output is plain text by default; add `--json` (before or after the subcommand) for one JSON object on stdout — agents should always pass it. Exit codes: 0 ok · 1 validation · 2 missing dep · 3 processing · 4 partial batch.
+
+```console
+$ pifang image avatar photo.jpg -o out/photo.webp --size 512
+OK image.avatar -> out/photo.webp
+
+$ pifang image avatar photo.jpg -o out/photo.webp --size 512 --json
+{"ok": true, "command": "image.avatar", "input": "/abs/photo.jpg", "output": "/abs/out/photo.webp",
+ "result": {"width": 512, "height": 512, "format": "webp", "bytes": 550}, "duration_ms": 18}
+
+$ pifang image avatar missing.jpg -o out/x.webp --json; echo "exit=$?"
+{"ok": false, "error_code": "FILE_NOT_FOUND", "message": "Input file not found: missing.jpg",
+ "exit_code": 1, "recovery": {"hint": "Check input path"}}
+exit=1
+```
+
+## For AI agents
+
+Most CLIs tolerate automation; pifang is designed for it. With `--json`, stdout is exactly one JSON object, success or failure; errors carry a stable `error_code`, a plain message and a `recovery.hint` down to the exact `pip install` to run. Exit codes mean something (`0` ok · `1` validation · `2` missing dependency · `3` processing · `4` partial batch). Typos in flags, enum values and pipe stages fail loudly with the valid options listed. Same input gives the same output; unchanged work is reported as skipped. `--help` at every level is the API doc.
+
+Paste **[docs/agents-blurb.md](https://github.com/StormForgeVentures/pifang/blob/main/docs/agents-blurb.md)** into your project’s `AGENTS.md` / `CLAUDE.md`.
+
+Optional Agent Skill: copy or symlink [`skills/pifang/SKILL.md`](https://github.com/StormForgeVentures/pifang/blob/main/skills/pifang/SKILL.md) into your runtime’s skills directory.
+
+## Custom recipes
+
+Drop YAML in `./.pifang/recipes/` or `~/.config/pifang/recipes/`.
+
+## Library use
+
+```python
+from pathlib import Path
+from pifang.core.recipe import run_recipe
+
+run_recipe("avatar", Path("photo.jpg"), Path("out.webp"), {"size": 256})
+```
+
+## Non-goals
+
+No GUI, no bundled Java/ffmpeg, no MCP server in 0.1.x, no generative/scene video engines. See [docs/out-of-scope.md](https://github.com/StormForgeVentures/pifang/blob/main/docs/out-of-scope.md).
+
+## Docs
+
+- [Contributing](https://github.com/StormForgeVentures/pifang/blob/main/CONTRIBUTING.md) · [Code of Conduct](https://github.com/StormForgeVentures/pifang/blob/main/CODE_OF_CONDUCT.md) · [Security](https://github.com/StormForgeVentures/pifang/blob/main/SECURITY.md) · [Changelog](https://github.com/StormForgeVentures/pifang/blob/main/CHANGELOG.md)
+- [Project brief](https://github.com/StormForgeVentures/pifang/blob/main/docs/project-brief.md) · [API design](https://github.com/StormForgeVentures/pifang/blob/main/docs/api-design.md) · [Glossary](https://github.com/StormForgeVentures/pifang/blob/main/docs/glossary.md)
+- [Publishing (PyPI)](https://github.com/StormForgeVentures/pifang/blob/main/docs/publishing.md)
+
+## License
+
+Apache-2.0 — see [LICENSE](https://github.com/StormForgeVentures/pifang/blob/main/LICENSE).