-
Notifications
You must be signed in to change notification settings - Fork 2
feat(cli): Include installation instruction cli overview #119
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.
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
Merged
dragosgheorghioiu
merged 1 commit into
prod-staging
from
dragosg/include-installation-instruction-cli-overview
Apr 23, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| --- | ||
| title: Kraft cloud CLI (legacy) | ||
| description: Legacy Kraft cloud CLI installation and quick start | ||
| --- | ||
|
|
||
| The **kraft cloud** CLI is part of the [KraftKit](https://github.com/unikraft/kraftkit) toolchain. | ||
| While it remains fully supported with ongoing bug fixes, it won't receive any new functionality. | ||
| New users should use the unikraft CLI instead. | ||
|
|
||
| ## Installation | ||
|
|
||
| For Windows, KraftKit currently requires Windows Subsystem for Linux 2 (WSL2). | ||
| Please ensure you set up WSL2 on your host (for example: run `wsl --install -d ubuntu` in PowerShell). | ||
|
|
||
| <CodeTabs> | ||
|
|
||
| ```bash title="1-liner (macOS & Linux)" | ||
| curl --proto '=https' --tlsv1.2 -sSf https://get.kraftkit.sh | sh | ||
| ``` | ||
|
|
||
| ```bash title="macOS" | ||
| brew install unikraft/tap/kraftkit | ||
| ``` | ||
|
|
||
| ```bash title="Debian/Ubuntu" | ||
| # Update and install dependencies | ||
| sudo apt-get update | ||
| sudo apt-get install \ | ||
| ca-certificates \ | ||
| curl \ | ||
| gnupg \ | ||
| lsb-release | ||
|
|
||
| # Add Unikraft's official GPG key: | ||
| sudo mkdir -p /etc/apt/keyrings | ||
| curl -fsSL https://deb.pkg.kraftkit.sh/gpg.key | \ | ||
| sudo gpg --dearmor -o /etc/apt/keyrings/unikraft.gpg | ||
|
|
||
| # Use the following command to set up the APT repository: | ||
| echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/unikraft.gpg] https://deb.pkg.kraftkit.sh /" | \ | ||
| sudo tee /etc/apt/sources.list.d/unikraft.list > /dev/null | ||
|
|
||
| # Update the APT package index, and install the latest version of kraftkit: | ||
| sudo apt-get update | ||
| sudo apt-get install kraftkit | ||
| ``` | ||
|
|
||
| ```bash title="Fedora/RHEL/Rocky/Alma" | ||
| # Add the Kraftkit repository | ||
| sudo tee /etc/yum.repos.d/kraftkit.repo <<EOF | ||
| [kraftkit] | ||
| name=KraftKit Repo | ||
| baseurl=https://rpm.pkg.kraftkit.sh | ||
| enabled=1 | ||
| gpgcheck=0 | ||
| EOF | ||
|
|
||
| # Install the CLI | ||
| yum makecache | ||
| yum install -y kraftkit | ||
| ``` | ||
|
|
||
| ```bash title="Arch" | ||
| git clone https://aur.archlinux.org/kraftkit-bin.git | ||
| cd kraftkit-bin | ||
| makepkg -si | ||
| ``` | ||
|
|
||
| ```bash title="Nix" | ||
| nix run github:unikraft/nur#kraftkit | ||
| ``` | ||
| </CodeTabs> | ||
|
|
||
| ## Quick start | ||
|
|
||
| ```sh | ||
| # Deploy an instance | ||
| kraft cloud deploy -p 443:8080/http+tls -M 512 . | ||
|
|
||
| # List instances | ||
| kraft cloud instance list | ||
| ``` | ||
|
|
||
| ## Choosing a CLI | ||
|
|
||
| | Feature | unikraft | kraft cloud | | ||
| |---------|----------|-------------| | ||
| | Recommended for new users | Yes | No | | ||
| | Profile management | Yes | Limited | | ||
| | Scale-to-zero support | Yes | Yes | | ||
| | Compose support | No | Yes | | ||
|
|
||
| If you are getting started with Unikraft Cloud, use the **unikraft** CLI. | ||
| If you need Docker Compose-style workflows use the **kraft cloud** CLI. | ||
|
|
||
| [Back to CLI overview](/docs/cli/overview) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.