Repository navigation
Development and feedback
CiviScribe has one public native ComfyUI V3 node. Its typed generation record feeds metadata projections, writers, filenames, sidecars, and display facts. Development work preserves active-branch selection, exact identity evidence, pixel quality, private-data handling, and existing-file protection.
Use the repository's locked Python environment and frontend dependencies. On Windows, invoke tools through Python modules to avoid relocated launchers.
.\.venv\Scripts\python.exe -m nox -s python frontend buildThis checks formatting, lint, strict types, locales, golden fixtures, sidecar schemas, Python coverage, frontend behavior, and package contents. The Python coverage gate requires 100 percent statements and branches.
For a release candidate, use the full profile.
.\.venv\Scripts\python.exe -m nox -s releaseIt adds process-interruption tests, advisory performance checks, dependency audits, an SBOM, and license reports. Locked dependencies can be downloaded during these sessions. Keep system TLS verification enabled.
The release workflow tests the built wheel, source archive, and node packages across Windows, Linux, and macOS. Linux also uses independent PNG, JPEG, WebP, and EXIF readers. A separate isolated ComfyUI job checks V3 registration, serialization, widget visibility, preview sizing, locales, and accessibility.
Performance tests are measurements on the current machine. Coverage and automated browser results describe the executed checks. Report real uploaded Civitai parser observations separately when testing catalog recognition.
The wiki's reviewed Markdown source is versioned in docs/wiki in the main
repository. _Sidebar.md and _Footer.md provide navigation. API examples
live in docs/examples. Publish the reviewed pages to the wiki Git repository
and check the rendered links after an update.
The repository maintenance guide records issue forms, labels, ownership, history protection, dependency review, and GitHub security settings. The normal Python gate checks documentation links, documented inputs, and JSON examples offline.
The in-node localization files cover English, Arabic, Persian, Spanish, French, Japanese, Korean, Portuguese (Brazil), Russian, Turkish, Simplified Chinese, and Traditional Chinese. The wiki is currently written in English.
Tell us what you were trying to do, how CiviScribe behaved, and what would make it easier. Feature suggestions and unusual workflow examples help guide future support. Use Discussions for ideas and questions, or Issues for reproducible bugs. Comments or private messages on Civitai are also welcome.
Review attachments before sharing so private prompts, paths, or credentials stay private. GitHub Discussions · GitHub Issues · Contributor guide
CiviScribe guide
- Home
- Installation and updates
- Quick start
- Settings reference
- Image formats
- Filenames and folders
- Counter examples
- Prompts and overrides
- Models and resource identities
- Civitai lookup and hashing
- Manual resource identities
- Workflow examples
- API and MCP
- Metadata and sidecars
- Privacy and saving safety
- Troubleshooting
- Verify a release
- Development and feedback