Add Restate CLI docs #249
Add Restate CLI docs #249
Conversation
Deploying with
|
| Latest commit: |
7524e8a
|
| Status: | ⚡️ Build in progress... |
| **Listing your services** | ||
|
|
||
| ```shell | ||
| restate svc list | ||
| ``` |
There was a problem hiding this comment.
A very useful/powerful command is also restate svc status which can take an optional argument (service name) if you want to filter out the output by a specific service.
It shows running the summary of the service and counters for invocations in various states. Is also shows the a sample of service keys that has active ongoing invocations.
There was a problem hiding this comment.
Cool, that is indeed a useful one! I added it.
| - `RESTATE_HOST`: The hostname/IP address of the server. Default is `localhost`. | ||
| - `RESTATE_HOST_SCHEME`: Default is `http`. | ||
| - `RESTATE_META_URL`: To specify the full URL of meta service (scheme+host+port). | ||
| - `RESTATE_DATAFUSION_HTTP_URL`: To specify the full URL of datafusion HTTP endpoint. |
There was a problem hiding this comment.
I'm very hesitant about exposing this as a "data fusion" thing. I would like to combine this with the META URL under one name "admin" URL. Let me work on this first.
|
|
||
| ## Usage | ||
|
|
||
| Here are a few useful commands: |
There was a problem hiding this comment.
Suggested: restate whoami is a good way to know if your CLI is configured correctly or not.
|
This is great and it would be very nice if we can add some screenshots of example outputs. |
I think it would be best to do this when the CLI and its printed output are a bit more stable since this will be intensive to maintain. Is that okay? |
Fixes #248