Skip to content

Commit 31b4a54

Browse files
committed
chore: Update kraft CLI reference for v0.7.7
Signed-off-by: Alexander Jung <alex@unikraft.io>
1 parent 745513f commit 31b4a54

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+843
-682
lines changed

configs/cli.sidebar.json

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,10 @@
8989
"title": "`kraft pkg ls`",
9090
"path": "/docs/cli/reference/kraft/pkg/ls"
9191
},
92+
{
93+
"title": "`kraft pkg info`",
94+
"path": "/docs/cli/reference/kraft/pkg/info"
95+
},
9296
{
9397
"title": "`kraft pkg pull`",
9498
"path": "/docs/cli/reference/kraft/pkg/pull"
@@ -136,6 +140,10 @@
136140
{
137141
"title": "`kraft stop`",
138142
"path": "/docs/cli/reference/kraft/stop"
143+
},
144+
{
145+
"title": "`kraft start`",
146+
"path": "/docs/cli/reference/kraft/start"
139147
}
140148
]
141149
},
@@ -172,46 +180,46 @@
172180
]
173181
},
174182
{
175-
"title": "Kraft Cloud Commands",
183+
"title": "Compose Commands",
176184
"sort": false,
177185
"open": true,
178186
"summarize": true,
179187
"routes": [
180188
{
181-
"title": "`kraft cloud deploy`",
182-
"path": "/docs/cli/reference/kraft/cloud/deploy"
189+
"title": "`kraft compose down`",
190+
"path": "/docs/cli/reference/kraft/compose/down"
183191
},
184192
{
185-
"title": "`kraft cloud img ls`",
186-
"path": "/docs/cli/reference/kraft/cloud/img/ls"
193+
"title": "`kraft compose ls`",
194+
"path": "/docs/cli/reference/kraft/compose/ls"
187195
},
188196
{
189-
"title": "`kraft cloud inst create`",
190-
"path": "/docs/cli/reference/kraft/cloud/instance/create"
197+
"title": "`kraft compose ps`",
198+
"path": "/docs/cli/reference/kraft/compose/ps"
191199
},
192200
{
193-
"title": "`kraft cloud inst delete`",
194-
"path": "/docs/cli/reference/kraft/cloud/instance/delete"
195-
},
196-
{
197-
"title": "`kraft cloud inst logs`",
198-
"path": "/docs/cli/reference/kraft/cloud/instance/logs"
199-
},
200-
{
201-
"title": "`kraft cloud inst ls`",
202-
"path": "/docs/cli/reference/kraft/cloud/instance/ls"
203-
},
201+
"title": "`kraft compose up`",
202+
"path": "/docs/cli/reference/kraft/compose/up"
203+
}
204+
]
205+
},
206+
{
207+
"title": "Microlibrary Commands",
208+
"sort": false,
209+
"open": true,
210+
"summarize": true,
211+
"routes": [
204212
{
205-
"title": "`kraft cloud inst start`",
206-
"path": "/docs/cli/reference/kraft/cloud/instance/start"
213+
"title": "`kraft lib add`",
214+
"path": "/docs/cli/reference/kraft/lib/add"
207215
},
208216
{
209-
"title": "`kraft cloud inst status`",
210-
"path": "/docs/cli/reference/kraft/cloud/instance/status"
217+
"title": "`kraft lib create`",
218+
"path": "/docs/cli/reference/kraft/lib/create"
211219
},
212220
{
213-
"title": "`kraft cloud inst stop`",
214-
"path": "/docs/cli/reference/kraft/cloud/instance/stop"
221+
"title": "`kraft lib remove`",
222+
"path": "/docs/cli/reference/kraft/lib/remove"
215223
}
216224
]
217225
},

content/docs/cli/reference/kraft/build.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,28 @@ description: Configure and build Unikraft unikernels
55

66
Build a Unikraft unikernel.
77

8-
The default behaviour of `kraft build` is to build a project.
9-
Given no arguments, you will be guided through interactive mode.
8+
The default behaviour of `kraft build` is to build a project. Given no
9+
arguments, you will be guided through interactive mode.
1010

11-
```console
11+
12+
```
1213
kraft build [FLAGS] [SUBCOMMAND|DIR]
1314
```
1415

1516
### Examples
1617

17-
```console
18+
```
1819
# Build the current project (cwd)
1920
$ kraft build
2021
2122
# Build path to a Unikraft project
2223
$ kraft build path/to/app
24+
2325
```
2426

2527
## Options
2628

27-
```text
29+
```
2830
--all Build all targets
2931
-m, --arch string Filter the creation of the build by architecture of known targets
3032
--build-log string Use the specified file to save the output from the build
@@ -40,10 +42,12 @@ $ kraft build path/to/app
4042
--no-fetch Do not run Unikraft's fetch step before building
4143
--no-update Do not update package index before running the build
4244
-p, --plat string Filter the creation of the build by platform of known targets
45+
--print-stats Print build statistics
4346
--rootfs string Specify a path to use as root file system (can be volume or initramfs)
4447
-t, --target string Build a particular known target
4548
```
4649

4750
## See Also
4851

49-
* [kraft](kraft.md) - Build and use highly customized and ultra-lightweight unikernels
52+
* [`kraft`](/docs/cli/reference/kraft): Build and use highly customized and ultra-lightweight unikernels
53+

content/docs/cli/reference/kraft/clean.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,23 @@ description: Remove the build object files of a Unikraft project
55

66
Remove the build object files of a Unikraft project
77

8-
```console
8+
```
99
kraft clean [DIR]
1010
```
1111

1212
### Examples
1313

14-
```console
14+
```
1515
# Clean the cwd build directory
1616
$ kraft clean
1717
18-
# clean a project at a path
18+
# properclean a project at a path
1919
$ kraft clean --proper path/to/app
2020
```
2121

2222
## Options
2323

24-
```text
24+
```
2525
-m, --arch string Filter prepare based on a target's architecture
2626
-h, --help help for clean
2727
-K, --kraftfile string Set an alternative path of the Kraftfile
@@ -32,5 +32,5 @@ $ kraft clean --proper path/to/app
3232

3333
## See Also
3434

35-
* [kraft](kraft.md) - Build and use highly customized and ultra-lightweight unikernels
35+
* [`kraft`](/docs/cli/reference/kraft): Build and use highly customized and ultra-lightweight unikernels
3636

content/docs/cli/reference/kraft/cloud.mdx

Lines changed: 0 additions & 60 deletions
This file was deleted.

content/docs/cli/reference/kraft/cloud/deploy.mdx

Lines changed: 0 additions & 36 deletions
This file was deleted.

content/docs/cli/reference/kraft/cloud/img.mdx

Lines changed: 0 additions & 26 deletions
This file was deleted.

content/docs/cli/reference/kraft/cloud/img/ls.mdx

Lines changed: 0 additions & 36 deletions
This file was deleted.

content/docs/cli/reference/kraft/cloud/instance.mdx

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)