Explore the engine
Read the overview and separate implemented behavior from planned scope.
Read overview → OuRi engineering · documentation foundation
The engine behind Arakul Studio.
Kraul Engine is the separate engine project associated with Arakul Studio. This documentation is the home for its architecture, image-processing workflows, API reference and implementation notes.
Start here
What can you do on this site?
Kraul Engine is the technical documentation project associated with Arakul Studio. Use this site to understand the intended scope, inspect API documentation and follow implementation status. It is not the image-editing workspace itself.
Find API guidance
Review the integration and API documentation before connecting another app.
Explore API →Open Arakul Studio
For the user-facing workspace and available tools, open Arakul Studio.
Open Arakul →Status note: documentation describes scope and intended interfaces; do not treat a documented or planned workflow as implemented unless the current code and tests confirm it.
01 / overview
One engine. Its own technical home.
Arakul Studio is the workspace users interact with. Kraul Engine is the separate engine layer intended to provide reusable processing capabilities and a documented API.
Image workflows
Project scope includes image-processing tasks such as background removal, foreground isolation and workflows involving transparent edges or alpha channels. Feature availability must be verified against the code.
ScopeA documented interface
Kraul has its own API. Its exact exports, parameters, accepted inputs, return values and error behavior should be documented from the actual implementation.
API referenceArakul Studio
Kraul and Arakul Studio are related but not interchangeable: the studio is the product/workspace, while the engine is the technical layer maintained in this repository.
OuRi ecosystem02 / architecture
Document the real system, not guesses.
This section will describe modules, processing flow, runtime boundaries, and how Arakul Studio calls Kraul once those details are verified in source.
Input contract
Document accepted image sources, file types, dimensions, color formats, validation and input limits.
Processing pipeline
Map the actual processing steps, dependencies, intermediate representations and failure points.
Output contract
Specify output formats, transparency behavior, quality controls, metadata handling and error results from real code.
Accuracy rule: this page is the documentation foundation. It does not claim that a particular model, endpoint, method, file format or processing pipeline is already implemented.
03 / API reference
Kraul API, documented precisely.
API pages will be filled from the engine's actual exported functions and contracts. No invented method names or signatures.
What every API entry should include
Export / method exact name from source
Inputs types, accepted formats, defaults
Output exact return shape and encoding
Errors validation and failure behavior
Example runnable, source-verified usage
Status implemented / in progress / planned
When the source code is available, this section can be expanded into a full reference with signatures, examples and compatibility notes.
04 / status
Clear status, no fake promises.
The repository has just received its documentation foundation. The labels below describe documentation status, not a claim that the engine's processing features are complete.
DocumentedProject relationship and intended scope
Being establishedRepository documentation structure
Needs source auditActual API names and contracts
Needs source auditImplemented processing features
05 / engineering handbook
Documentation, expanded.
A deeper technical handbook for contributors, integration work and future implementation. Each guide separates design recommendations from behavior verified in source.
Getting started
Repository map, contributor setup, verification checklist and what is required for a real runnable quick-start.
Read guide ↗Image processing
Input/output contracts, transparency, masks, encoding, cancellation and acceptance criteria.
Read guide ↗Arakul Studio
System boundaries, data ownership, adapter responsibilities, compatibility and integration tests.
Read guide ↗Error model
Error categories, validation order, retry safety, privacy-safe diagnostics and verification requirements.
Read guide ↗Testing strategy
Unit, integration, visual regression, resource, documentation and deployment test layers.
Read guide ↗Security & privacy
Untrusted inputs, memory exhaustion, network boundaries, metadata and dependency hygiene.
Read guide ↗Performance
Measurement discipline, memory estimates, profiling order and a reproducible benchmark template.
Read guide ↗Contributing
Source-backed API changes, review criteria, tests and release documentation expectations.
Read guide ↗Roadmap
Staged development plan from documentation foundation to tested engine implementation.
Read guide ↗Glossary
Shared definitions for alpha, masks, pipelines, API contracts and verification status.
Read guide ↗FAQ
Answers about engine readiness, Docker, deployment, API verification and project boundaries.
Read guide ↗API & architecture
Continue to the API contract, system architecture and implementation status pages.
API ↗ Architecture ↗ Status ↗06 / guide index
Choose a guide
Карточки выше ведут к этим якорям на этой же странице. Для полного текста открой соответствующее руководство.
Getting started
Карта репозитория, чек-лист первого запуска, требования к настоящему quick-start и текущие ограничения проекта.
Full guide ↗Image processing
Контракты входных и выходных изображений, прозрачность, маски, кодирование, отмена и критерии приёмки.
Full guide ↗Arakul Studio
Граница между студией и движком, владение данными, адаптеры, совместимость и интеграционные тесты.
Full guide ↗Error model
Категории ошибок, порядок проверки входных данных, безопасные повторы и диагностика без утечки приватных данных.
Full guide ↗Testing strategy
Статические проверки, unit- и integration-тесты, визуальные регрессии, проверка ресурсов и публикации.
Full guide ↗Security & privacy
Недоверенные изображения, ограничения памяти, сетевые границы, метаданные и безопасность зависимостей.
Full guide ↗Performance
Методика измерений, оценка памяти, порядок профилирования и воспроизводимый шаблон бенчмарков.
Full guide ↗Contributing
Правила вклада, изменения API только по исходному коду, критерии ревью и ожидания к тестам.
Full guide ↗Roadmap
Этапы от документационной основы до реализации движка, тестирования, интеграции и стабилизации.
Full guide ↗Glossary
Общие определения alpha-канала, масок, пайплайнов, API-контрактов и статусов проверки.
Full guide ↗FAQ
Ответы о готовности Kraul, Docker/Jekyll, публикации, API и границах проектов Kraul, Arakul и QKC.
Full guide ↗API reference
Шаблон точного описания экспортов, параметров, входов, результатов, ошибок и подтверждающих тестов.
Full guide ↗Architecture
Целевые слои системы, потоки данных, владение ресурсами и вопросы, которые нужно подтвердить исходным кодом.
Full guide ↗Implementation status
Что уже подтверждено в репозитории, а что пока задумано, не реализовано или требует проверки.
Full guide ↗Evidence first: this handbook is substantially expanded, but Kraul's current repository does not yet contain the engine runtime source. The guides do not pretend that proposed workflows or APIs are already implemented.