Skip to content

Commit 556ab5b

Browse files
authored
Docs update with the deploy subcommands (#8)
<!-- mesa-description-start --> ## TL;DR Added documentation for the `deploy` subcommands to the `README.md`. ## Why we made these changes The `deploy` subcommands were undocumented, making them difficult for users to discover and use. This update provides clear instructions and examples to improve the user experience. ## What changed? - `README.md`: Reorganized the CLI command reference by renaming the "App Management" section to "Deployments." - Added documentation for the `deploy logs` and `deploy history` subcommands under the new "Deployments" section. <sup>_Description generated by Mesa. [Update settings](https://app.mesa.dev/onkernel/settings/pull-requests)_</sup> <!-- mesa-description-end -->
1 parent 55755c1 commit 556ab5b

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,15 +103,24 @@ Create an API key from the [Kernel dashboard](https://dashboard.onkernel.com).
103103
- `kernel logout` - Clear stored credentials
104104
- `kernel auth` - Check authentication status
105105

106-
### App Management
106+
### App Deployment
107107

108108
- `kernel deploy <file>` - Deploy an app to Kernel
109-
110109
- `--version <version>` - Specify app version (default: latest)
111110
- `--force` - Allow overwriting existing version
112111
- `--env <KEY=VALUE>`, `-e` - Set environment variables (can be used multiple times)
113112
- `--env-file <file>` - Load environment variables from file (can be used multiple times)
114113

114+
- `kernel deploy logs <deployment_id>` - Stream logs for a deployment
115+
- `--follow`, `-f` - Follow logs in real-time (stream continuously)
116+
- `--since`, `-s` - How far back to retrieve logs. Duration formats: ns, us, ms, s, m, h (e.g., 5m, 2h, 1h30m). Timestamps also supported: 2006-01-02, 2006-01-02T15:04, 2006-01-02T15:04:05, 2006-01-02T15:04:05.000
117+
- `--with-timestamps`, `-t` - Include timestamps in each log line
118+
119+
- `kernel deploy history [app_name]` - Show deployment history
120+
- `--all` - Show deployment history for all applications
121+
122+
### App Management
123+
115124
- `kernel invoke <app> <action>` - Run an app action
116125

117126
- `--version <version>`, `-v` - Specify app version (default: latest)

0 commit comments

Comments
 (0)