Skip to content

Commit 0fe6bf0

Browse files
docs: update CLI docs and version for v0.6.0-rc.2
1 parent 9277fee commit 0fe6bf0

File tree

6 files changed

+45
-7
lines changed

6 files changed

+45
-7
lines changed

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export default {
3131
},
3232
search: { provider: 'local' },
3333
nav: [
34-
{ text: 'v0.5.2', link: 'https://github.com/gcstr/dockform/releases/' }
34+
{ text: 'v0.6.0-rc.2', link: 'https://github.com/gcstr/dockform/releases/' }
3535
],
3636
sidebar: {
3737
'/': [

docs/cli/dockform.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Manage Docker Compose projects declaratively
2222

2323
* [dockform apply](/cli/dockform_apply) - Apply the desired state
2424
* [dockform completion](/cli/dockform_completion) - Generate the autocompletion script for the specified shell
25-
* [dockform compose](/cli/dockform_compose) - Work with docker compose files for applications
25+
* [dockform compose](/cli/dockform_compose) - Work with docker compose files for stacks
26+
* [dockform dashboard](/cli/dockform_dashboard) - Launch the Dockform dashboard (fullscreen TUI)
2627
* [dockform destroy](/cli/dockform_destroy) - Destroy all managed resources
2728
* [dockform doctor](/cli/dockform_doctor) - Run a quick health scan and report system readiness for Dockform
2829
* [dockform init](/cli/dockform_init) - Create a template dockform.yml configuration file

docs/cli/dockform_compose.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Dockform Compose
44

55
# `dockform compose`
66

7-
Work with docker compose files for applications
7+
Work with docker compose files for stacks
88

99
### Options
1010

@@ -26,5 +26,5 @@ Work with docker compose files for applications
2626
### SEE ALSO
2727

2828
* [dockform](/cli/dockform) - Manage Docker Compose projects declaratively
29-
* [dockform compose render](/cli/dockform_compose_render) - Render an application's docker compose config fully resolved
29+
* [dockform compose render](/cli/dockform_compose_render) - Render a stack's docker compose config fully resolved
3030

docs/cli/dockform_compose_render.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ title: Dockform Compose Render
44

55
# `dockform compose render`
66

7-
Render an application's docker compose config fully resolved
7+
Render a stack's docker compose config fully resolved
88

99
```
10-
dockform compose render [application] [flags]
10+
dockform compose render [stack] [flags]
1111
```
1212

1313
### Options
@@ -31,5 +31,5 @@ dockform compose render [application] [flags]
3131

3232
### SEE ALSO
3333

34-
* [dockform compose](/cli/dockform_compose) - Work with docker compose files for applications
34+
* [dockform compose](/cli/dockform_compose) - Work with docker compose files for stacks
3535

docs/cli/dockform_dashboard.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Dockform Dashboard
3+
---
4+
5+
# `dockform dashboard`
6+
7+
Launch the Dockform dashboard (fullscreen TUI)
8+
9+
```
10+
dockform dashboard [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for dashboard
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-c, --config string Path to configuration file or directory (defaults: dockform.yml, dockform.yaml, Dockform.yml, Dockform.yaml in current directory)
23+
--log-file string Write JSON logs to file (in addition to stderr)
24+
--log-format string Log format: auto, pretty, json (default "auto")
25+
--log-level string Log level: debug, info, warn, error (default "info")
26+
--no-color Disable color in pretty logs
27+
-v, --verbose Verbose error output
28+
```
29+
30+
### SEE ALSO
31+
32+
* [dockform](/cli/dockform) - Manage Docker Compose projects declaratively
33+

docs/cli/sidebar.mts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ export default [
2424
],
2525
"collapsed": true
2626
},
27+
{
28+
"text": "dashboard",
29+
"link": "/cli/dockform_dashboard"
30+
},
2731
{
2832
"text": "destroy",
2933
"link": "/cli/dockform_destroy"

0 commit comments

Comments
 (0)