Skip to content

Commit

Permalink
chore: Update kraft CLI reference for v0.7.7
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Jung <alex@unikraft.io>
  • Loading branch information
nderjung committed Feb 21, 2024
1 parent 745513f commit 31b4a54
Show file tree
Hide file tree
Showing 53 changed files with 843 additions and 682 deletions.
56 changes: 32 additions & 24 deletions configs/cli.sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,10 @@
"title": "`kraft pkg ls`",
"path": "/docs/cli/reference/kraft/pkg/ls"
},
{
"title": "`kraft pkg info`",
"path": "/docs/cli/reference/kraft/pkg/info"
},
{
"title": "`kraft pkg pull`",
"path": "/docs/cli/reference/kraft/pkg/pull"
Expand Down Expand Up @@ -136,6 +140,10 @@
{
"title": "`kraft stop`",
"path": "/docs/cli/reference/kraft/stop"
},
{
"title": "`kraft start`",
"path": "/docs/cli/reference/kraft/start"
}
]
},
Expand Down Expand Up @@ -172,46 +180,46 @@
]
},
{
"title": "Kraft Cloud Commands",
"title": "Compose Commands",
"sort": false,
"open": true,
"summarize": true,
"routes": [
{
"title": "`kraft cloud deploy`",
"path": "/docs/cli/reference/kraft/cloud/deploy"
"title": "`kraft compose down`",
"path": "/docs/cli/reference/kraft/compose/down"
},
{
"title": "`kraft cloud img ls`",
"path": "/docs/cli/reference/kraft/cloud/img/ls"
"title": "`kraft compose ls`",
"path": "/docs/cli/reference/kraft/compose/ls"
},
{
"title": "`kraft cloud inst create`",
"path": "/docs/cli/reference/kraft/cloud/instance/create"
"title": "`kraft compose ps`",
"path": "/docs/cli/reference/kraft/compose/ps"
},
{
"title": "`kraft cloud inst delete`",
"path": "/docs/cli/reference/kraft/cloud/instance/delete"
},
{
"title": "`kraft cloud inst logs`",
"path": "/docs/cli/reference/kraft/cloud/instance/logs"
},
{
"title": "`kraft cloud inst ls`",
"path": "/docs/cli/reference/kraft/cloud/instance/ls"
},
"title": "`kraft compose up`",
"path": "/docs/cli/reference/kraft/compose/up"
}
]
},
{
"title": "Microlibrary Commands",
"sort": false,
"open": true,
"summarize": true,
"routes": [
{
"title": "`kraft cloud inst start`",
"path": "/docs/cli/reference/kraft/cloud/instance/start"
"title": "`kraft lib add`",
"path": "/docs/cli/reference/kraft/lib/add"
},
{
"title": "`kraft cloud inst status`",
"path": "/docs/cli/reference/kraft/cloud/instance/status"
"title": "`kraft lib create`",
"path": "/docs/cli/reference/kraft/lib/create"
},
{
"title": "`kraft cloud inst stop`",
"path": "/docs/cli/reference/kraft/cloud/instance/stop"
"title": "`kraft lib remove`",
"path": "/docs/cli/reference/kraft/lib/remove"
}
]
},
Expand Down
16 changes: 10 additions & 6 deletions content/docs/cli/reference/kraft/build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,28 @@ description: Configure and build Unikraft unikernels

Build a Unikraft unikernel.

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

```console

Check failure on line 11 in content/docs/cli/reference/kraft/build.mdx

View workflow job for this annotation

GitHub Actions / Markdown Linter

Multiple consecutive blank lines [Expected: 1; Actual: 2]
```

Check failure on line 12 in content/docs/cli/reference/kraft/build.mdx

View workflow job for this annotation

GitHub Actions / Markdown Linter

Fenced code blocks should have a language specified [Context: "```"]
kraft build [FLAGS] [SUBCOMMAND|DIR]
```

### Examples

```console
```

Check failure on line 18 in content/docs/cli/reference/kraft/build.mdx

View workflow job for this annotation

GitHub Actions / Markdown Linter

Fenced code blocks should have a language specified [Context: "```"]
# Build the current project (cwd)
$ kraft build
# Build path to a Unikraft project
$ kraft build path/to/app
```

## Options

```text
```

Check failure on line 29 in content/docs/cli/reference/kraft/build.mdx

View workflow job for this annotation

GitHub Actions / Markdown Linter

Fenced code blocks should have a language specified [Context: "```"]
--all Build all targets
-m, --arch string Filter the creation of the build by architecture of known targets
--build-log string Use the specified file to save the output from the build
Expand All @@ -40,10 +42,12 @@ $ kraft build path/to/app
--no-fetch Do not run Unikraft's fetch step before building
--no-update Do not update package index before running the build
-p, --plat string Filter the creation of the build by platform of known targets
--print-stats Print build statistics
--rootfs string Specify a path to use as root file system (can be volume or initramfs)
-t, --target string Build a particular known target
```

## See Also

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

10 changes: 5 additions & 5 deletions content/docs/cli/reference/kraft/clean.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ description: Remove the build object files of a Unikraft project

Remove the build object files of a Unikraft project

```console
```

Check failure on line 8 in content/docs/cli/reference/kraft/clean.mdx

View workflow job for this annotation

GitHub Actions / Markdown Linter

Fenced code blocks should have a language specified [Context: "```"]
kraft clean [DIR]
```

### Examples

```console
```

Check failure on line 14 in content/docs/cli/reference/kraft/clean.mdx

View workflow job for this annotation

GitHub Actions / Markdown Linter

Fenced code blocks should have a language specified [Context: "```"]
# Clean the cwd build directory
$ kraft clean
# clean a project at a path
# properclean a project at a path
$ kraft clean --proper path/to/app
```

## Options

```text
```

Check failure on line 24 in content/docs/cli/reference/kraft/clean.mdx

View workflow job for this annotation

GitHub Actions / Markdown Linter

Fenced code blocks should have a language specified [Context: "```"]
-m, --arch string Filter prepare based on a target's architecture
-h, --help help for clean
-K, --kraftfile string Set an alternative path of the Kraftfile
Expand All @@ -32,5 +32,5 @@ $ kraft clean --proper path/to/app

## See Also

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

60 changes: 0 additions & 60 deletions content/docs/cli/reference/kraft/cloud.mdx

This file was deleted.

36 changes: 0 additions & 36 deletions content/docs/cli/reference/kraft/cloud/deploy.mdx

This file was deleted.

26 changes: 0 additions & 26 deletions content/docs/cli/reference/kraft/cloud/img.mdx

This file was deleted.

36 changes: 0 additions & 36 deletions content/docs/cli/reference/kraft/cloud/img/ls.mdx

This file was deleted.

32 changes: 0 additions & 32 deletions content/docs/cli/reference/kraft/cloud/instance.mdx

This file was deleted.

Loading

0 comments on commit 31b4a54

Please sign in to comment.