Skip to content

Commit 803e900

Browse files
committed
feat: update README to include docs for command
1 parent 600a65e commit 803e900

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

README.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Kernel provides sandboxed, ready-to-use Chrome browsers for browser automations
2121

2222
### What you can do with the CLI
2323

24+
- Create new Kernel applications from templates
2425
- Deploy and version apps to Kernel
2526
- Invoke app actions (sync or async) and stream logs
2627
- Create, list, view, and delete managed browser sessions
@@ -50,19 +51,25 @@ kernel --version
5051

5152
## Quick Start
5253

53-
1. **Authenticate with Kernel:**
54+
1. **Create a new Kernel app:**
55+
56+
```bash
57+
kernel create
58+
```
59+
60+
2. **Authenticate with Kernel:**
5461

5562
```bash
5663
kernel login
5764
```
5865

59-
2. **Deploy your first app:**
66+
3. **Deploy your app:**
6067

6168
```bash
6269
kernel deploy index.ts
6370
```
6471

65-
3. **Invoke your app:**
72+
4. **Invoke your app:**
6673
```bash
6774
kernel invoke my-app action-name --payload '{"key": "value"}'
6875
```
@@ -103,6 +110,20 @@ Create an API key from the [Kernel dashboard](https://dashboard.onkernel.com).
103110
- `kernel logout` - Clear stored credentials
104111
- `kernel auth` - Check authentication status
105112

113+
### App Creation
114+
115+
- `--name <name>`, `-n` - Name of the application
116+
- `--language <language>`, `-l` - Sepecify app language: `typescript`, or `python`
117+
- `--template <template>`, `-t` - Template to use:
118+
- `sample-app` - Basic template with Playwright integration
119+
- `advanced-sample` - Sample apps using advanced Kernel configs
120+
- `stagehand` - Template with Stagehand SDK (TypeScript only)
121+
- `browser-use` - Template with Browser Use SDK (Python only)
122+
- `computer-use` - Anthropic Computer Use prompt loop
123+
- `cua` - OpenAI Computer Using Agent (CUA) sample
124+
- `gemini-cua` - Google Gemini CUA sample (TypeScript only)
125+
- `magnitude` - Magnitude framework sample (TypeScript only)
126+
106127
### App Deployment
107128

108129
- `kernel deploy <file>` - Deploy an app to Kernel
@@ -356,6 +377,25 @@ Create an API key from the [Kernel dashboard](https://dashboard.onkernel.com).
356377

357378
## Examples
358379

380+
### Create a new app
381+
382+
```bash
383+
# Interactive mode (prompts for all options)
384+
kernel create
385+
386+
# Create a TypeScript app with sample template
387+
kernel create --name my-app --language typescript --template sample-app
388+
389+
# Create a Python app with Browser Use
390+
kernel create --name my-scraper --language python --template browser-use
391+
392+
# Create a TypeScript app with Stagehand
393+
kernel create --name my-agent --language ts --template stagehand
394+
395+
# Create a Python Computer Use app
396+
kernel create --name my-cu-app --language py --template computer-use
397+
```
398+
359399
### Deploy with environment variables
360400

361401
```bash

0 commit comments

Comments
 (0)