Skip to content

feat: add canvas init section into cli docs #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Vukotije wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −0
Open

feat: add canvas init section into cli docs #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions src/content/docs/installation/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,32 @@ superplane canvases get <canvas_name_or_id> -o yaml

## Managing canvases

### Generate a starter canvas YAML

Print a blank canvas YAML skeleton to stdout:

```sh
superplane canvases init
```

Start from an existing template:

```sh
superplane canvases init --template health-check-monitor
```

List available templates:

```sh
superplane canvases init --list-templates
```

Write directly to a file instead of stdout:

```sh
superplane canvases init --output-file canvas.yaml
```

### Create a canvas

```sh
Expand Down