Skip to content

Commit d0def05

Browse files
committed
deploy from github docs update
1 parent 578fb1f commit d0def05

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

apps/deploy.mdx

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,41 @@ Once you deploy an app on Kernel, you can schedule its actions on a job or run t
99

1010
## Deploy the app
1111

12+
### From local directory
13+
1214
Use our CLI from the root directory of your project:
1315
```bash
1416
# entrypoint_file_name should be where you've defined your Kernel app
1517
kernel deploy <entrypoint_file_name>
1618
```
1719

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+
1847
## Environment variables
1948

2049
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
3160

3261
## Deployment notes
3362

34-
- The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app.
3563
- **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`.
64+
- View deployment logs using: `kernel deploy logs <deployment_id> --follow`
3765
- Kernel assumes the root directory contains at least this file structure:
3866

3967
<CodeGroup>

quickstart.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ kernel deploy main.py # --env ANTHROPIC_API_KEY=XXX if Browser Use or Computer U
7171

7272
</CodeGroup>
7373

74+
**Advanced:** You can also [deploy directly from GitHub](/apps/deploy#from-github) without downloading code locally.
75+
7476
## 5. Invoke the app
7577

7678
<CodeGroup>

0 commit comments

Comments
 (0)