pixelkiln 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +50 -1
- package/NAMING.md +15 -15
- package/PROVIDERS.md +128 -90
- package/README.md +57 -16
- package/SECURITY.md +4 -3
- package/dist/cli.d.ts +18 -1
- package/dist/cli.js +1248 -281
- package/dist/cli.js.map +1 -1
- package/dist/index.cjs +911 -102
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +547 -228
- package/dist/index.d.ts +547 -228
- package/dist/index.js +887 -102
- package/dist/index.js.map +1 -1
- package/docs/AGENTS.md +13 -6
- package/docs/ARCHITECTURE.md +27 -15
- package/docs/CLI.md +57 -4
- package/docs/ENDPOINTS.md +39 -38
- package/docs/GENERATORS.md +6 -1
- package/docs/GETTING_STARTED.md +24 -5
- package/docs/LIBRARY.md +4 -4
- package/docs/MANIFEST.md +103 -5
- package/docs/PIXELLAB.md +100 -0
- package/docs/PROVIDER_BENCHMARK.md +134 -0
- package/docs/README.md +4 -1
- package/docs/RECOVERY.md +46 -1
- package/docs/RETRO_DIFFUSION.md +110 -0
- package/docs/TILES.md +1 -1
- package/examples/minimal/README.md +2 -2
- package/package.json +3 -1
- package/schema/manifest.schema.json +15 -1
- package/schema/workspace.schema.json +54 -0
- package/skills/pixelkiln/SKILL.md +15 -8
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$ref": "#/definitions/PixelkilnWorkspace",
|
|
3
|
+
"definitions": {
|
|
4
|
+
"PixelkilnWorkspace": {
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"version": {
|
|
8
|
+
"type": "number",
|
|
9
|
+
"const": 1
|
|
10
|
+
},
|
|
11
|
+
"projects": {
|
|
12
|
+
"type": "array",
|
|
13
|
+
"items": {
|
|
14
|
+
"type": "object",
|
|
15
|
+
"properties": {
|
|
16
|
+
"id": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"minLength": 1
|
|
19
|
+
},
|
|
20
|
+
"manifest": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"minLength": 1
|
|
23
|
+
},
|
|
24
|
+
"lock": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"minLength": 1
|
|
27
|
+
},
|
|
28
|
+
"provider": {
|
|
29
|
+
"type": "string",
|
|
30
|
+
"minLength": 1,
|
|
31
|
+
"default": "pixellab"
|
|
32
|
+
},
|
|
33
|
+
"account": {
|
|
34
|
+
"type": "string"
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
"required": [
|
|
38
|
+
"id",
|
|
39
|
+
"manifest",
|
|
40
|
+
"lock"
|
|
41
|
+
],
|
|
42
|
+
"additionalProperties": false
|
|
43
|
+
},
|
|
44
|
+
"default": []
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
"required": [
|
|
48
|
+
"version"
|
|
49
|
+
],
|
|
50
|
+
"additionalProperties": false
|
|
51
|
+
}
|
|
52
|
+
},
|
|
53
|
+
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
54
|
+
}
|
|
@@ -11,9 +11,10 @@ submission, reviewed by a human, and recorded with exact provenance.
|
|
|
11
11
|
## Working rules
|
|
12
12
|
|
|
13
13
|
- Locate `pixelkiln.manifest.json` first. Paths are manifest-relative.
|
|
14
|
-
- Never inspect, print, or commit provider credentials.
|
|
15
|
-
|
|
16
|
-
|
|
14
|
+
- Never inspect, print, or commit provider credentials. Read the manifest's
|
|
15
|
+
top-level `provider`: PixelKiln loads `PIXELLAB_API_KEY` for `pixellab` and
|
|
16
|
+
`RD_API_KEY` for experimental `retrodiffusion` from `.env.local` beside the
|
|
17
|
+
manifest or from the current working directory.
|
|
17
18
|
- Run `pixelkiln doctor --dry-run` and `pixelkiln plan` before paid work. Report
|
|
18
19
|
actionable, recoverable, and estimated cost figures with their provider unit.
|
|
19
20
|
- Do not regenerate recoverable work. Use `pixelkiln restore` first.
|
|
@@ -42,10 +43,16 @@ debugging one phase. Use `restore` for missing bytes, `adopt` for exact matches
|
|
|
42
43
|
already in the provider account, and `salvage` for reviewed unclaimed objects.
|
|
43
44
|
Use `pack`, `mount`, or `export` only for the artifact format the project needs.
|
|
44
45
|
|
|
45
|
-
PixelKiln's orchestration is provider-neutral. PixelLab is
|
|
46
|
-
|
|
47
|
-
|
|
46
|
+
PixelKiln's orchestration is provider-neutral. PixelLab is its production and
|
|
47
|
+
paid-generation-tested adapter. Retro Diffusion stills, tileset sheets,
|
|
48
|
+
animated GIFs, and PNG spritesheets are experimental. Authenticated RD Fast and
|
|
49
|
+
RD Plus single-candidate stills have passed from quote through validated output
|
|
50
|
+
and recovery. Advanced workflows remain mock-tested.
|
|
51
|
+
`FakeProvider` is the deterministic test adapter. Do not describe Retro
|
|
52
|
+
Diffusion as production-ready until representative multi-candidate, tileset,
|
|
53
|
+
GIF, and spritesheet live smoke tests pass.
|
|
48
54
|
|
|
49
55
|
When working in the PixelKiln repository, consult `docs/GETTING_STARTED.md` for
|
|
50
|
-
the full workflow, `docs/
|
|
51
|
-
|
|
56
|
+
the full workflow, `docs/PIXELLAB.md` or `docs/RETRO_DIFFUSION.md` for provider
|
|
57
|
+
setup, `docs/CLI.md` for flags, `docs/MANIFEST.md` for the schema, and
|
|
58
|
+
`docs/RECOVERY.md` before account adoption, salvage, discard, or purge.
|