-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add docs for blueprint and configuration
- Loading branch information
Showing
6 changed files
with
211 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# the cli | ||
|
||
The cli provides a thin wrapper to access the rest-api of scotty. It is | ||
written in rust and provides a simple interface to list, create, update and | ||
destroy apps. You can get some helps by running `scotty --help` and | ||
`scotty --help <command>`. | ||
|
||
## List all apps | ||
|
||
```shell | ||
scotty --server <SERVER> --token <TOKEN>t app:list | ||
``` | ||
|
||
Example-output: | ||
|
||
![Example output of app:list](assets/cli/app-list.png) | ||
|
||
The table contains all apps with their status, uptime and urls. The urls are the | ||
public urls of the apps. The status can be one of the following: | ||
|
||
* Running: The app is running | ||
* Stopped: The app is stopped | ||
* Unsupported: The app is not supported by the server | ||
|
||
## Get info about an app | ||
|
||
```shell | ||
scotty --server <SERVER> --token <TOKEN> app:info <APP> | ||
``` | ||
|
||
Example-output: | ||
|
||
![Example output of app:info](assets/cli/app-info.png) | ||
|
||
The command list all services of a specific app and their status. The output | ||
contains also the enabled notification services for that app. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters