debatefloor / docs /source /cli.md
mitalimehta's picture
deploy(space): 5K results + updated README/blog/notebook
be81cf6
|
raw
history blame
1.53 kB
# CLI
The `openenv` CLI provides a set of commands for building, validating, and pushing environments to Hugging Face Spaces or a custom Docker registry. For an end-to-end tutorial on building environments with OpenEnv, see the [building an environment](auto_getting_started/environment-builder.md) guide.
## `openenv init`
```{eval-rst}
.. automodule:: openenv.cli.commands.init
:members:
:undoc-members:
:show-inheritance:
```
## `openenv build`
```{eval-rst}
.. automodule:: openenv.cli.commands.build
:members:
:undoc-members:
:show-inheritance:
```
## `openenv validate`
```{eval-rst}
.. automodule:: openenv.cli.commands.validate
:members:
:undoc-members:
:show-inheritance:
```
## `openenv push`
```{eval-rst}
.. automodule:: openenv.cli.commands.push
:members:
:undoc-members:
:show-inheritance:
```
## `openenv serve`
```{eval-rst}
.. automodule:: openenv.cli.commands.serve
:members:
:undoc-members:
:show-inheritance:
```
## `openenv fork`
```{eval-rst}
.. automodule:: openenv.cli.commands.fork
:members:
:undoc-members:
:show-inheritance:
```
# API Reference
## Entry point
```{eval-rst}
.. automodule:: openenv.cli.__main__
:members:
:undoc-members:
:show-inheritance:
```
## CLI helpers
```{eval-rst}
.. automodule:: openenv.cli._cli_utils
:members:
:undoc-members:
:show-inheritance:
```
## Validation utilities
```{eval-rst}
.. automodule:: openenv.cli._validation
:members:
:undoc-members:
:show-inheritance:
```