everypixel-cli 0.1.0__tar.gz

everypixel_cli-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+.tmp/
+pytest-cache-files-*/
+pytest_tmp_run/
+dist/
+build/
+*.egg-info/
+.venv/
+venv/

everypixel_cli-0.1.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+## [0.1.0] - 2026-08-17
+
+Initial public release.
+
+### Added
+
+- Image generation with `zimage`, `wan22`, `wan2.7`, `wan2.7-pro`, `flux2`,
+  `grok`, `grok_quality`, `gemini-3.1-flash`, `gemini-3-pro`,
+  `seedream-5-pro`, `seedream-5`, and GPT Image 2 low, medium, and high models.
+- Image editing with `flux2`, `qwen`, `wan2.7`, `wan2.7-pro`, `grok`,
+  `grok_quality`, Gemini 3, Seedream 5, and GPT Image 2 model families.
+- Image upscaling with `seedvr2`, camera-angle generation, and color transfer.
+- Video generation with `wan22`, `ltx23`, `grok`, `grok15`, `veo-3.1`,
+  `veo-3.1-fast`, `seedance2`, `seedance2-mini`, `kling-2.6`, `kling-3`,
+  `kling-3-turbo`, `kling-3-omni`, and `wan2.7`.
+- Text-to-video, image-to-video, first/last-frame generation, video editing,
+  and video upscaling to 720p, 1080p, or 1440p.
+- Video editing with `seedance2`, `seedance2-mini`, `kling-3-omni`, `wan2.7`,
+  and `aleph2`, including provider-specific media and keyframe inputs.
+- Video and image lipsync, with `inftalk` and `ltx23` available for image
+  animation.
+- Audio transcription, text-to-speech with built-in speakers, voice cloning,
+  and character voice generation.
+- Image keywords and colors, image quality and UGC quality scores, face
+  analysis, image captioning, and video keywords.
+- Shared asynchronous task status, polling, timeout, cancellation, and streamed
+  result downloads with safe atomic filenames.
+- Local file, HTTP(S) URL, and data URI media inputs with payload validation
+  before network requests.
+- Human-readable and JSON output, `--jq` filtering, stable exit codes, and
+  sanitized debug diagnostics.
+- Named profiles, development-environment selection, environment overrides,
+  Basic Auth checks, and keyring-backed credential storage.
+- Generic `run` support for OpenAPI operations with live, cached, and bundled
+  schemas plus local `$ref`, composed-schema, and constraint validation.
+- A stdio MCP server exposing the same image, video, audio, task, analysis,
+  authentication, and OpenAPI workflows as 26 structured tools.
+- `everypixel` and `epx` command entry points for Python 3.10 and newer.

everypixel_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Everypixel Labs
+
+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.

everypixel_cli-0.1.0/PKG-INFO

@@ -0,0 +1,454 @@
+Metadata-Version: 2.5
+Name: everypixel-cli
+Version: 0.1.0
+Summary: Official command line interface for Everypixel API
+Project-URL: Homepage, https://labs.everypixel.com
+Project-URL: Repository, https://github.com/everypixel/everypixel-cli
+Project-URL: Issues, https://github.com/everypixel/everypixel-cli/issues
+Author: Everypixel Labs
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,automation,cli,everypixel,image,video
+Requires-Python: >=3.10
+Requires-Dist: anyio<5,>=4
+Requires-Dist: click<9,>=8.1
+Requires-Dist: httpx>=0.27
+Requires-Dist: jsonschema<5,>=4.23
+Requires-Dist: keyring>=25.0
+Requires-Dist: mcp<3,>=2
+Requires-Dist: platformdirs>=4.2
+Requires-Dist: pydantic>=2.8
+Requires-Dist: referencing>=0.35
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8.2; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.12; extra == 'dev'
+Requires-Dist: tomli>=2; (python_version < '3.11') and extra == 'dev'
+Requires-Dist: types-jsonschema>=4.23; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Everypixel CLI
+
+Official command-line interface for the [Everypixel API](https://labs.everypixel.com/).
+Generate and edit images and videos, work with audio, run visual analysis, and
+automate Everypixel workflows from a terminal or an MCP client.
+
+The CLI is designed for both people and agents: commands use readable terminal
+output by default and can return stable JSON for scripts and tool integrations.
+
+- [Everypixel Labs](https://labs.everypixel.com/)
+- [API documentation](https://labs.everypixel.com/docs)
+- [GitHub repository](https://github.com/everypixel/everypixel-cli)
+- [Issue tracker](https://github.com/everypixel/everypixel-cli/issues)
+
+## Installation
+
+Everypixel CLI requires Python 3.10 or newer.
+
+```bash
+pip install everypixel-cli
+```
+
+The package installs two equivalent commands:
+
+```bash
+everypixel --help
+epx --help
+```
+
+## Quick Start
+
+Create API credentials in your Everypixel Labs account, then save them in a
+local CLI profile:
+
+```bash
+everypixel auth configure \
+  --client-id "$EVERYPIXEL_CLIENT_ID" \
+  --client-secret "$EVERYPIXEL_CLIENT_SECRET"
+
+everypixel auth check
+```
+
+Generate an image and download the completed result:
+
+```bash
+everypixel image generate \
+  "editorial product photo on a white background" \
+  --model flux2 \
+  --size square \
+  --download ./outputs
+```
+
+The same command can return JSON for automation:
+
+```bash
+everypixel image generate \
+  "editorial product photo on a white background" \
+  --model flux2 \
+  --no-wait \
+  --output-json
+```
+
+Use `--help` on any command to see all supported models and options:
+
+```bash
+everypixel image generate --help
+everypixel video edit --help
+```
+
+## Authentication
+
+Everypixel uses HTTP Basic Auth with the client ID as the username and the
+client secret as the password. You can save credentials with `auth configure`
+or provide them through environment variables:
+
+```bash
+export EVERYPIXEL_CLIENT_ID="your-client-id"
+export EVERYPIXEL_CLIENT_SECRET="your-client-secret"
+```
+
+| Variable | Purpose |
+| --- | --- |
+| `EVERYPIXEL_CLIENT_ID` | API client ID |
+| `EVERYPIXEL_CLIENT_SECRET` | API client secret |
+| `EVERYPIXEL_BASE_URL` | Override the API base URL |
+| `EVERYPIXEL_PROFILE` | Select a saved configuration profile |
+| `NO_COLOR` | Disable colored terminal output when set |
+
+Explicit command-line options take priority over environment variables, and
+environment variables take priority over saved configuration.
+
+Useful authentication commands:
+
+| Command | Description |
+| --- | --- |
+| `everypixel auth configure` | Save credentials for the current profile |
+| `everypixel auth check` | Verify the configured credentials |
+| `everypixel auth whoami` | Show the active profile and credential source |
+| `everypixel auth logout` | Remove credentials from the current profile |
+
+Secrets are stored in the operating system keyring when one is available. The
+CLI falls back to its user configuration file when a keyring is unavailable;
+`everypixel config list` masks saved secrets in its output.
+
+## Commands
+
+### Images
+
+| Command | Description |
+| --- | --- |
+| `everypixel image generate PROMPT` | Generate an image from a text prompt |
+| `everypixel image edit PROMPT --image FILE` | Edit one or more images |
+| `everypixel image upscale` | Upscale an image, URL, or existing task result |
+| `everypixel image angles --image FILE` | Change the camera angle of an image |
+| `everypixel image colors --image FILE --reference FILE` | Transfer colors from a reference image |
+
+Examples:
+
+```bash
+everypixel image edit \
+  "replace the background with a clean studio wall" \
+  --image ./input.png \
+  --model qwen \
+  --download ./outputs
+
+everypixel image upscale --image ./input.png --download ./outputs
+
+everypixel image angles \
+  --image ./input.png \
+  --azimuth right \
+  --elevation eye_level \
+  --distance medium \
+  --download ./outputs
+```
+
+### Video
+
+| Command | Description |
+| --- | --- |
+| `everypixel video generate PROMPT` | Generate video from text |
+| `everypixel video from-image PROMPT --image FILE` | Animate an image |
+| `everypixel video first-last PROMPT` | Generate video between first and last frames |
+| `everypixel video edit` | Edit video with text and media references |
+| `everypixel video upscale` | Upscale a video, URL, or existing task result |
+
+Examples:
+
+```bash
+everypixel video generate \
+  "a slow aerial shot over mountain lakes" \
+  --model ltx23 \
+  --duration 10 \
+  --resolution 720p \
+  --download ./outputs
+
+everypixel video from-image \
+  "subtle camera movement and natural wind" \
+  --image ./first-frame.png \
+  --model ltx23 \
+  --download ./outputs
+
+everypixel video edit \
+  "make the scene cinematic" \
+  --video ./input.mp4 \
+  --download ./outputs
+```
+
+### Lipsync and Audio
+
+| Command | Description |
+| --- | --- |
+| `everypixel lipsync video` | Synchronize a video with an audio track |
+| `everypixel lipsync image` | Create a lipsync video from a still image and audio |
+| `everypixel audio transcribe` | Transcribe speech from an audio file |
+| `everypixel audio tts-create` | Create speech with a built-in speaker |
+| `everypixel audio tts-clone` | Create speech from a cloned voice sample |
+| `everypixel audio tts-voice` | Create speech with a character voice |
+
+Examples:
+
+```bash
+everypixel lipsync video \
+  --video ./input.mp4 \
+  --audio ./voice.mp3 \
+  --download ./outputs
+
+everypixel audio transcribe \
+  --audio ./speech.mp3 \
+  --language English \
+  --download ./outputs
+
+everypixel audio tts-create \
+  --text "Hello world" \
+  --speaker Ryan \
+  --style Warm \
+  --language English \
+  --download ./outputs
+```
+
+### Visual Analysis
+
+Analysis commands accept HTTP(S) URLs and local files. Local files are uploaded
+automatically when the endpoint supports them.
+
+| Command | Description |
+| --- | --- |
+| `everypixel keywords --image FILE` | Extract image keywords |
+| `everypixel quality --image FILE` | Score technical image quality |
+| `everypixel quality-ugc --image FILE` | Score user-generated image quality |
+| `everypixel faces --image FILE` | Detect faces in an image |
+| `everypixel captioning --image FILE` | Generate an image caption |
+| `everypixel video-keywords --video FILE` | Extract video keywords |
+
+```bash
+everypixel keywords \
+  --image ./image.jpg \
+  --lang en \
+  --num-keywords 10 \
+  --colors \
+  --output-json
+
+everypixel captioning --image ./image.jpg --output-json
+```
+
+## Async Tasks and Downloads
+
+Generation and media-processing commands wait for completion by default. Add
+`--no-wait` to return the newly created task immediately.
+
+```bash
+everypixel image generate "minimalist poster" --no-wait --output-json
+```
+
+Use `status` for one status request and `wait` to poll until the task reaches a
+terminal state:
+
+```bash
+everypixel status TASK_ID
+everypixel wait TASK_ID
+```
+
+Passing `--download` always waits for a successful result before saving files:
+
+```bash
+everypixel wait TASK_ID --download ./outputs
+```
+
+A Bash automation example:
+
+```bash
+task_id="$(
+  everypixel image generate \
+    "automation test image" \
+    --model flux2 \
+    --no-wait \
+    --output-json \
+    --jq .task_id | tr -d '"'
+)"
+
+everypixel --timeout 600 wait "$task_id" --download ./outputs
+```
+
+## Generic OpenAPI Runner
+
+`everypixel run` calls an API operation by its OpenAPI name or `/v1/...` path.
+Values passed with `--input` are parsed as JSON when possible. The CLI validates
+named operations against the selected OpenAPI schema before sending a request.
+
+```bash
+everypixel run image_generate \
+  --prompt "product photo" \
+  --input model=flux2 \
+  --input image_size=square \
+  --dry-run
+
+everypixel run image_generate --help-schema --output-json
+
+everypixel run /v1/image_generate \
+  --method POST \
+  --input-file ./payload.json
+```
+
+The schema loader tries the live API first, then the local cache, and finally
+the schema bundled with the package.
+
+```bash
+everypixel docs open
+everypixel docs openapi --output-json
+everypixel docs refresh
+```
+
+## JSON Output
+
+Use `--output-json` (or `-j`) for scripts and `--jq` to select part of the
+result:
+
+```bash
+everypixel keywords --image ./image.jpg --output-json
+everypixel keywords --image ./image.jpg --output-json --jq .keywords
+```
+
+Handled successes and errors are written as one machine-readable JSON stream to
+stdout. Human-readable errors are written to stderr. Add `--debug` when an
+unexpected internal error needs sanitized stack-frame locations.
+
+## Global Options
+
+Global options must appear before the command they apply to.
+
+| Option | Description |
+| --- | --- |
+| `--base-url URL` | Override the API base URL for one invocation |
+| `--profile NAME` | Use a saved configuration profile |
+| `--output human\|json` | Select the output format |
+| `--output-json`, `-j` | Shortcut for JSON output |
+| `--jq EXPRESSION` | Filter JSON output |
+| `--wait`, `--no-wait` | Control async task polling |
+| `--timeout SECONDS` | Set the polling timeout |
+| `--poll-interval SECONDS` | Set the delay between status requests |
+| `--download DIRECTORY`, `-d DIRECTORY` | Download completed result files |
+| `--no-color` | Disable colored terminal output |
+| `--debug` | Include sanitized diagnostic locations for internal errors |
+
+Many operation-specific options can also appear after their command. Run
+`everypixel COMMAND --help` for the exact syntax.
+
+## Configuration Profiles
+
+Profiles keep credentials and settings separate for different accounts or
+projects. Most users can stay on the `default` profile.
+
+```bash
+everypixel config profile create project-a
+everypixel config profile use project-a
+everypixel auth configure \
+  --client-id "$PROJECT_A_CLIENT_ID" \
+  --client-secret "$PROJECT_A_CLIENT_SECRET"
+
+everypixel config list
+```
+
+Select a profile for one invocation without changing the active profile:
+
+```bash
+everypixel --profile project-a auth check
+```
+
+## MCP Server
+
+Everypixel CLI includes an MCP server for Claude Desktop, Claude Code, Cursor,
+VS Code, and other clients that support MCP over stdio:
+
+```bash
+everypixel mcp serve
+```
+
+Example client configuration:
+
+```json
+{
+  "mcpServers": {
+    "everypixel": {
+      "command": "everypixel",
+      "args": ["mcp", "serve"],
+      "env": {
+        "EVERYPIXEL_CLIENT_ID": "your-client-id",
+        "EVERYPIXEL_CLIENT_SECRET": "your-client-secret"
+      }
+    }
+  }
+}
+```
+
+The MCP client launches the command as a subprocess; no HTTP port is opened.
+Local media and download paths use the subprocess working directory and
+filesystem permissions.
+
+## Shell Completion
+
+Install completion for the current shell:
+
+```bash
+everypixel --install-completion
+```
+
+Or print the completion script for manual setup:
+
+```bash
+everypixel --show-completion
+```
+
+## Exit Codes
+
+| Code | Meaning |
+| --- | --- |
+| `0` | Success |
+| `1` | General error |
+| `2` | Local argument or validation error |
+| `3` | Configuration or authentication error |
+| `4` | API, remote service, or task failure |
+| `5` | File read/write or result download error |
+| `6` | Result processing, jq, or serialization error |
+
+## Troubleshooting
+
+- Authentication failure: run `everypixel auth check`, then configure the
+  credentials again if needed.
+- Wait timeout: increase the global timeout, for example
+  `everypixel --timeout 600 wait TASK_ID`.
+- Invalid media: pass an existing local file, an HTTP(S) URL, or a supported
+  data URI.
+- File not found: use an absolute path or run the command from the directory
+  containing the file.
+- Download failure: verify that the output directory is writable and retry with
+  `everypixel wait TASK_ID --download ./outputs`.
+- No color: pass `--no-color` or set `NO_COLOR=1`.
+
+## License
+
+[MIT](LICENSE)