Skip to content

Commit 2b8eea3

Browse files
authored
Updated deployment notes (#45)
Added deployment notes about entrypoint file and dependency manifest to the Deploy CLI section + Deploy guide page.
1 parent c99befd commit 2b8eea3

2 files changed

Lines changed: 5 additions & 0 deletions

File tree

apps/deploy.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ kernel deploy my_app.py --env MY_ENV_VAR=my_value # Can add multiple env vars de
3232
## Deployment notes
3333

3434
- The `entrypoint_file_name` is the file name where you [defined](/apps/develop) your app.
35+
- **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.**
3536
- Include a `.gitignore` file to exclude dependency folders like `node_modules` and `.venv`.
3637
- Kernel assumes the root directory contains at least this file structure:
3738

reference/cli/apps.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Deploy an app to Kernel from the current directory.
1212
| `--env <ENV_VAR=VAL>`, `-e` | Adds environment variables to the app. May be specified multiple times. Optional. |
1313
| `--env-file <file>` | Read environment variables from a .env file. May be specified multiple times. Optional. |
1414

15+
<Info>
16+
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.
17+
</Info>
18+
1519
## `kernel invoke <app_name> <action_name>`
1620
Invoke a specific app action by its name. Generates an Invocation.
1721

0 commit comments

Comments
 (0)