Skip to content

Commit 41fe1db

Browse files
committed
added command reference to documentation
1 parent 802048d commit 41fe1db

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

Documentation/.vuepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ module.exports = {
99
'/installation',
1010
'/filesystems',
1111
'/steps',
12+
'/commands',
1213
'/custom-behaviours'
1314
],
1415
theme: '@vuepress/theme-default',

Documentation/commands.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Commands
2+
3+
### `backup:list`
4+
5+
Lists backups available.
6+
7+
```bash
8+
./flow backup:list
9+
```
10+
11+
#### Options
12+
`--offset` <br />
13+
The index where this command should start listing
14+
15+
`--limit` <br />
16+
The number of backups shown
17+
18+
19+
### `backup:create`
20+
21+
Creates a single backup.
22+
23+
```bash
24+
./flow backup:create
25+
```
26+
27+
28+
### `backup:restore`
29+
30+
Restores a single backup.
31+
32+
```bash
33+
./flow backup:restore <name>
34+
```
35+
36+
#### Options
37+
`--no-confirm` <br />
38+
If this flag is set, you dont have to confirm this action by pressing `Y` + `Return`.
39+
40+
41+
### `backup:delete`
42+
43+
Deletes a single backup.
44+
45+
```bash
46+
./flow backup:delete <name>
47+
```
48+
49+
#### Options
50+
`--no-confirm` <br />
51+
If this flag is set, you dont have to confirm this action by pressing `Y` + `Return`.

0 commit comments

Comments
 (0)