You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/getting_started/contributing-envs.md
+14-2Lines changed: 14 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,11 +46,23 @@ openenv push --private
46
46
openenv push path/to/my_env
47
47
```
48
48
49
-
That's it. The CLI validates your environment, stages the files, adds the Hugging Face Space frontmatter, enables the web interface, and uploads everything. Your environment will be live at
49
+
That's it. The CLI authenticates with Hugging Face, prepares the exact Space
50
+
revision, runs the strict `publish` profile on that snapshot in a dedicated HF
51
+
Sandbox, adds an unofficial author report, and uploads the same revision. Your
> If you are getting errors on deployment, it is likely because the environment structure is not valid. Run `openenv validate --verbose` to see the errors. This checks for the required files (`openenv.yaml`, `pyproject.toml`, `server/app.py`) and validates the Dockerfile and entry points.
56
+
> Run `openenv validate --profile publish --remote --verbose` before pushing.
57
+
> Failed and incomplete criteria include configuration locations and suggested
58
+
> fixes. A publish-ready environment also needs a `task.toml` requirements
Copy file name to clipboardExpand all lines: docs/source/getting_started/environment-builder.md
+18-3Lines changed: 18 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,10 @@ openenv init my_env
74
74
openenv init my_env --output-dir /Users/you/envs
75
75
```
76
76
77
-
The command creates a fully-typed template with `openenv.yaml`, `pyproject.toml`, `uv.lock`, Docker assets, and stub implementations. If you're working inside this repo, move the generated folder under `envs/`.
77
+
The command creates a fully-typed template with `openenv.yaml`, a Harbor schema
`openenv build` understands both standalone environments and in-repo ones. Useful flags:
@@ -327,7 +332,12 @@ openenv validate --verbose
327
332
-`--dockerfile` / `--context`: custom locations when experimenting
328
333
-`--no-cache`: force fresh dependency installs
329
334
330
-
`openenv validate` checks for required files, ensures the Dockerfile/server entrypoints function, and lists supported deployment modes. The command exits non-zero if issues are found so you can wire it into CI.
335
+
`openenv validate` always uses the shared validation report. The `static` and
336
+
`runtime` profiles support fast iteration; `publish` is strict and exits
337
+
non-zero when a blocking check fails, errors, or cannot run. `--remote` runs
338
+
the environment in a dedicated HF Sandbox. Human output includes typed fixes,
339
+
while `--json` or `--output` provides the same structured report for agents and
340
+
CI.
331
341
332
342
### 8. Push & Share with `openenv push`
333
343
@@ -361,7 +371,12 @@ Key options:
361
371
-`--env-var/-e KEY=VALUE`: set a public Space variable (repeatable); overrides matching keys from `variables:` in `openenv.yaml`
362
372
-`--secret KEY=VALUE`: set a private Space secret (repeatable); value is never logged
363
373
364
-
The command validates your `openenv.yaml`, injects Hugging Face frontmatter when needed, and uploads the prepared bundle.
374
+
For Hub pushes, the command prepares the bundle (including Hugging Face
375
+
frontmatter), validates that exact snapshot remotely, and uploads it together
376
+
with `.openenv/validation-report.json`. That versioned report is unofficial
377
+
author evidence. When deployed, the Hub's broader certification suite will
378
+
publish an independent result rather than trusting or overwriting the author
379
+
report.
365
380
Space variables and secrets are only applied on direct Hugging Face Space pushes;
366
381
they are not available for `--registry`, and they cannot be staged through
0 commit comments