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: apps/deploy.mdx
+30-2Lines changed: 30 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,12 +9,41 @@ Once you deploy an app on Kernel, you can schedule its actions on a job or run t
9
9
10
10
## Deploy the app
11
11
12
+
### From local directory
13
+
12
14
Use our CLI from the root directory of your project:
13
15
```bash
14
16
# entrypoint_file_name should be where you've defined your Kernel app
15
17
kernel deploy <entrypoint_file_name>
16
18
```
17
19
20
+
#### Notes
21
+
22
+
- The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app.
23
+
- Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`.
24
+
25
+
### From GitHub
26
+
27
+
You can deploy an app directly from a public or private GitHub repository using the Kernel CLI — no need to clone or manually push code.
28
+
29
+
```bash
30
+
kernel deploy github \
31
+
--url https://github.com/<owner>/<repo> \
32
+
--ref <branch|tag|commit> \
33
+
--entrypoint <path/to/entrypoint> \
34
+
[--path <optional/subdir>] \
35
+
[--github-token <token>] \
36
+
[--env KEY=value ...] \
37
+
[--env-file .env] \
38
+
[--version latest] \
39
+
[--force]
40
+
```
41
+
42
+
#### Notes
43
+
44
+
- The CLI automatically downloads and extracts the GitHub source, prunes large dependency folders (like `node_modules`), and uploads your app for deployment.
45
+
- For private repositories, provide a `--github-token` or set the `GITHUB_TOKEN` environment variable.
46
+
18
47
## Environment variables
19
48
20
49
You can set environment variables for your app using the `--env` flag. For example:
@@ -31,9 +60,8 @@ kernel deploy my_app.py --env MY_ENV_VAR=my_value # Can add multiple env vars de
31
60
32
61
## Deployment notes
33
62
34
-
- The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app.
35
63
-**The entrypoint file and dependency manifest (`package.json` for JS/TS, `pyproject.toml` for Python) must both be in the root directory of your project.**
36
-
-Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`.
0 commit comments