CLI Reference
Everything the koyoapp command does, one page.
Commands#
| Command | Action |
|---|---|
koyoapp create NAME |
Scaffold a new project (use . for the current directory). |
koyoapp dev |
Run the dev server with live reload on port 2309 by default. |
koyoapp add PKG |
Declare a dependency and install it (pin or specifier). |
koyoapp remove PKG |
Remove a dependency from both groups and uninstall it. |
koyoapp install |
Create .venv if needed and install all dependencies. |
koyoapp upgrade [VERSION] |
Upgrade koyoapp in the project venv and pin the installed version in pyproject.toml. |
koyoapp build |
Prerender static routes to .koyo/build/site. |
koyoapp --version / -v |
Print the installed koyoapp version and exit. |
Common options#
| Option | Applies to | Effect |
|---|---|---|
--port PORT |
dev |
Override the listen port (default 2309). |
--host HOST |
dev |
Bind address (default all interfaces). |
--verbose |
dev, add, remove, install |
Stream detailed output to the terminal. |
--dev |
add |
Write to the dev optional dependency group. |
--no-dev |
install |
Skip the dev dependency group. |
--clean |
install |
Delete and recreate .venv before installing. |
[VERSION] |
upgrade |
Specific koyoapp version, for example 0.3.0. Defaults to the latest release. |
-v, --version |
top-level | Print the koyoapp version and exit. |
Examples#
koyoapp create my-app
cd my-app
koyoapp dev --port 8080 --host 127.0.0.1
koyoapp add requests
koyoapp add "httpx>=0.27" --dev
koyoapp install --no-dev
koyoapp upgrade # latest
koyoapp upgrade 0.3.0 # pinned
koyoapp build
koyoapp --version
The dependency commands report "not a koyo project" with a hint when
run outside a folder containing koyo.config.py.