arkade is how developers install the latest versions of their favourite tools and Kubernetes apps.
arkade get, you'll have
jq on your machine faster than you can type
apt-get install/brew update.
With over 100 CLIs and 55 Kubernetes apps (charts, manifests, installers) available for Kubernetes, gone are the days of contending with dozens of README files just to set up a development stack with the usual suspects like ingress-nginx, Postgres and cert-manager.
Alex Arkade is built to save you time at work so you can focus and get productive quickly.
You can support Alex's work on arkade via GitHub Sponsors.
Or get a copy of his eBook on Go so you can learn how to build tools like k3sup, arkade and OpenFaaS for yourself:
I was setting up a new dev environment yesterday. Kind, helm, kustomize, kubectl, all this stuff. My take is - arkade is highly underappreciated. I'd spend an hour in the past to install such tools. With arkade it was under ten minutes.
Ivan Velichko, SRE @ Booking.com
Before arkade whenever I used to spin up an instance, I used to go to multiple sites and download the binary. Arkade is one of my favourite tools.
Kumar Anurag - Cloud Native Enthusiast
It's hard to use K8s without Arkade these days. My team at @lftechnology absolutely loves it.
arkade is really a great tool to install CLI tools, and system packages, check this blog on how to get started with arkade it's a time saver.
This is real magic get #kubernetes up and going in a second; then launch #openfaas a free better than lambda solution that uses docker images.
for getting the basics installed, nothing beats arkade it can install commonly used cli tools like kubectl locally for you, as well as common k8s pkgs like ingress-nginx or portainer
I finally got around to installing Arkade, super simple! quicker to install this than the argocli standalone commands, but there are lots of handy little tools in there. also, the neat little part about arkade, not only does it make it easy to install a ton of different apps and CLIs you can also get the info on them as well pretty quickly.
You've to install latest and greatest tools for your daily @kubernetesio tasks? No problem, check out #arkade the open source #kubernetes marketplace 👍
Thorsten Hans - Cloud Native consultant
If you want to install quickly a new tool in your dev env or in your k8s cluster you can use the Arkade (https://awesomeopensource.com/project/alexellis/arkade) easy and quick you should try out! Ps. I contribute to this project 🥰
Carlos Panato - Staff engineer @ Mattermost
arkade is the 'brew install' of Kubernetes. You can install and run an application in a single command. Finally! https://awesomeopensource.com/project/alexellis/arkade / by Alex Ellis
John Arundel - Cloud consultant, author
# Note: you can also run without `sudo` and move the binary yourself curl -sLS https://get.arkade.dev | sudo sh arkade --help ark --help # a handy alias # Windows users with Git Bash curl -sLS https://get.arkade.dev | sh
Windows users: arkade requires bash to be available, therefore Windows users should install and use Git Bash
An alias of
ark is created at installation time, so you can also run
ark install APP
Arkade can be used to install Kubernetes apps or to download CLI tools.
arkade install- install a Kubernetes app
arkade info- see the post installation screen for a Kubernetes app
arkade get- download a CLI tool
arkade update- update arkade itself
An arkade "app" could represent a helm chart such as
openfaas/faas-netes, a custom CLI installer such as
istioctl or a set of static manifests (i.e. MetalLB).
An arkade "tool" is a CLI that can be downloaded for your operating system. Arkade downloads statically-linked binaries from their upstream locations on GitHub or a the vendor's chosen URL such as with
Did you know? Arkade users run
arkade getboth on their local workstations, and on their CI runners such as GitHub Actions or Jenkins.
arkade downloads the correct version of a CLI for your OS and CPU.
With automatic detection of: Windows / MacOS / Linux / Intel / ARM.
# Download a binary release of a tool arkade get kubectl # Download a specific version of that tool arkade get [email protected] # Download multiple tools at once arkade get kubectl \ helm \ istioctl # Download multiple specific versions arkade get [email protected] \ [email protected] # Override machine os/arch arkade get faas-cli \ --arch arm64 \ --os linux # Override machine os/arch arkade get faas-cli \ --arch arm64 \ --os darwin
This is a time saver compared to searching for download pages every time you need a tool.
arkade get TOOL as a doing for CLIs, what
arkade install does for helm.
Adding a new tool for download is as simple as editing tools.go.
System packages are tools designed for installation on a Linux workstation, server or CI runner.
These are a more limited group of applications designed for quick setup, scripting and CI, and generally do not fit into the
arkade get pattern, due to additional installation steps or system configuration.
# Show packages arkade system install # Show package flags arkade system install go --help # Install latest version of Go to /usr/local/bin/go arkade system install go # Install Go 1.18 to /tmp/go arkade system install go \ --version 1.18 \ --path /tmp/ # Install containerd for ARM64, 32-bit ARM or x86_64 # with systemd enabled arkade install system containerd \ --systemd
Run the following to see what's available
arkade system install:
actions-runner Install GitHub Actions Runner cni Install CNI plugins containerd Install containerd firecracker Install Firecracker go Install Go node Install Node.js prometheus Install Prometheus tc-redirect-tap Install tc-redirect-tap registry Install Open Source Registry implementation for storing and distributing container images using the OCI Distribution Specification
The initial set of system apps is now complete, learn more in the original proposal: Feature: system packages for Linux servers, CI and workstations #654
There are two GitHub Actions available for arkade
- uses: alexellis/[email protected] - name: Install kubectl & Helm run: arkade get kubectl \ helm
Example downloading faas-cli (specific version) and kubectl (latest), putting them into the PATH automatically, and executing one of them in a subsequent step.
- uses: alexellis/[email protected] - uses: alexellis/[email protected] with: kubectl: latest faas-cli: 0.14.10 - name: check for faas-cli run: | faas-cli version
There are two commands built into arkade designed for software vendors and open source maintainers.
arkade helm chart upgrade- run this command to scan for container images and update them automatically by querying a remote registry.
arkade helm chart verify- after changing the contents of a values.yaml or docker-compose.yaml file, this command will check each image exists on a remote registry
Whilst end-users may use a GitOps-style tool to deploy charts and update their versions, maintainers need to make conscious decisions about when and which images to change within a Helm chart or compose file.
These two features are used by OpenFaaS Ltd on projects and products like OpenFaaS CE/Pro (Serverless platform) and faasd (docker-compose file).
With the command
arkade chart upgrade you can upgrade the image tags of a Helm chart from within a values.yaml file to the latest available semantically versioned image.
Original YAML file:
stan: # Image used for nats deployment when using async with NATS-Streaming. image: nats-streaming:0.24.6
Running the command with
--verbose prints the upgraded tags to stderr, allowing the output to stdout to be piped to a file.
arkade chart upgrade -f \ ~/go/src/github.com/openfaas/faas-netes/chart/openfaas/values.yaml \ --verbose 2023/01/03 10:12:47 Verifying images in: /home/alex/go/src/github.com/openfaas/faas-netes/chart/openfaas/values.yaml 2023/01/03 10:12:47 Found 18 images 2023/01/03 10:12:48 [natsio/prometheus-nats-exporter] 0.8.0 => 0.10.1 2023/01/03 10:12:50 [nats-streaming] 0.24.6 => 0.25.2 2023/01/03 10:12:52 [prom/prometheus] v2.38.0 => 2.41.0 2023/01/03 10:12:54 [prom/alertmanager] v0.24.0 => 0.25.0 2023/01/03 10:12:54 [nats] 2.9.2 => 2.9.10
Updated YAML file printed to console:
stan: # Image used for nats deployment when using async with NATS-Streaming. image: nats-streaming:0.25.2
Write the updated image tags back to the file:
arkade chart upgrade -f \ ~/go/src/github.com/openfaas/faasd/docker-compose.yaml \ --write
image:- at the top level
component.image:i.e. one level of nesting
Not supported yet:
arkade chart verify command validates that all images specified are accessible on a remote registry and takes a values.yaml file as its input.
Successful checking of a chart with
arkade chart verify -f ~/go/src/github.com/openfaas/faas-netes/chart/cron-connector/values.yaml echo $? 0
There is an exit code of zero and no output when the check passed.
You can pass
--verbose to see a detailed view of what's happening.
Checking of nested components, where two of the images do not exist
arkade chart verify -f ~/go/src/github.com/openfaas/faas-netes/chart/openfaas/values.yamlecho $? 2 images are missing in /Users/alex/go/src/github.com/openfaas/faas-netes/chart/openfaas/values.yaml COMPONENT IMAGE dashboard ghcr.io/openfaasltd/openfaas-dashboard:0.9.8 autoscaler ghcr.io/openfaasltd/autoscaler:0.2.5 Error: verifying failed echo $? 1
image:- at the top level
component.image:i.e. one level of nesting
Not supported yet:
You'll need a Kubernetes cluster to arkade. Unlike cloud-based marketplaces, arkade doesn't have any special pre-requirements and can be used with any private or public cluster.
If you have Docker installed, then you can install Kubernetes using KinD in a matter of moments:
arkade get [email protected] \ [email protected] kind create cluster
You can also download k3d k3s in the same way with
arkade get k3d.
No need to worry about whether you're installing to Intel or ARM architecture, the correct values will be set for you automatically.
arkade install openfaas \ --gateways 2 \ --load-balancer false
The post-installation message shows you how to connect. And whenever you want to see those details again, just run
arkade info openfaas.
There's even more options you can chose with
arkade install openfaas --help - the various flags you see map to settings from the helm chart README, that you'd usually have to look up and set via a
If there's something missing from the list of flags that you need, arkade also supports
--set for any arkade app that uses helm. Note that not every app uses helm.
Remember how awkward it was last time you installed the Kubernetes dashboard? And how you could never remember the command to get the token to log in?
arkade install kubernetes-dashboard
Forgot your token?
arkade info kubernetes-dashboard
This is an example of an arkade app that uses static YAML manifests instead of helm.
Prefer Portainer? Just run:
arkade install portainer
arkade uninstall or
arkade delete for more information on how to remove applications from a Kubernetes cluster.
Normally up to a dozen commands (including finding and downloading helm), now just one. No searching for the correct CRD to apply, no trying to install helm, no trying to find the correct helm repo to add:
arkade install cert-manager
Other common tools:
arkade install ingress-nginx arkade install metrics-server
We use strongly typed Go CLI flags, so that you can run
--help instead of trawling through countless Helm chart README files to find the correct
--set combination for what you want.
arkade install ingress-nginx --help Install ingress-nginx. This app can be installed with Host networking for cases where an external LB is not available. please see the --host-mode flag and the ingress-nginx docs for more info Usage: arkade install ingress-nginx [flags] Aliases: ingress-nginx, nginx-ingress Examples: arkade install ingress-nginx --namespace default Flags: -h, --help help for ingress-nginx --host-mode If we should install ingress-nginx in host mode. -n, --namespace string The namespace used for installation (default "default") --update-repo Update the helm repo (default true)
You can also set helm overrides, for apps which use helm via
ark install openfaas --set faasIdler.dryRun=false
After installation, an info message will be printed with help for usage, you can get back to this at any time via:
arkade info <NAME>
Apps are easier to discover and install than helm chart which involve many more manual steps, however when you compound apps together, they really save you time.
Here's how you can get a self-hosted Docker registry with TLS and authentication in just 5 commands on an empty cluster:
Here's how you would bootstrap OpenFaaS with TLS:
arkade install ingress-nginx arkade install cert-manager arkade install openfaas arkade install openfaas-ingress \ --email [email protected] \ --domain openfaas.example.com
And here's what it looks like for a private Docker registry with authentication enabled:
arkade install ingress-nginx arkade install cert-manager arkade install docker-registry arkade install docker-registry-ingress \ --email [email protected] \ --domain reg.example.com
arkade install inlets-operator \ --access-token $HOME/digitalocean-token \ --region lon1 \ --provider digitalocean
This makes your cluster behave like it was on a public cloud and LoadBalancer IPs go from Pending to a real, functioning IP.
You can view the various apps available with
arkade install / --help, more are available when you run the command yourself.
arkade install --help ark --help Examples: arkade install arkade install openfaas --helm3 --gateways=2 arkade install inlets-operator --token-file $HOME/do-token
See the full catalog of apps: See all apps
To suggest a new app, please check past issues and raise an issue for it. Think also whether your app suggestion would be a good candidate for a Sponsored App.
You can now propose your project or product as a Sponsored App. Sponsored Apps work just like any other app that we've curated, however they will have a note next to them in the app description
(sponsored) and a link to your chosen site upon installation. An app sponsorship can be purchased for a minimum of 12 months and includes free development of the Sponsored App, with ongoing support via GitHub for the Sponsored App for the duration only. Ongoing support will be limited to a set amount of hours per month.
When your sponsorship expires the Sponsored App will be removed from arkade, and the ongoing support will cease. A Sponsored App can be renewed 60 days prior to expiration subject to a separate agreement and payment.
arkade VENDOR install PRODUCT arkade acmeco install dashboard
Contact OpenFaas Ltd to find out how you can have your Sponsored App added to arkade.
In the same way that brew uses git and Makefiles to compile applications for your Mac,
arkade uses upstream helm charts and
kubectl to install applications to your Kubernetes cluster. arkade exposes strongly-typed flags for the various popular options for helm charts, and enables easier discovery through
arkade install --help and
arkade install APP --help.
If you consider helm suitable, and
kubectl then yes, arkade by definition uses those tools and the upstream artifacts of OSS projects.
Do you want to run arkade in a CI or CD pipeline? Go ahead.
Generally speaking, tools that are used with the various arkade apps or with Kubernetes are in scope. If you want to propose a tool, raise a GitHub issue.
What about package management?
arkade get provides a faster alternative to package managers like
brew, you're free to use either or both at the same time.
When required, tools, CLIs, and the helm binaries are downloaded and extracted to
If installing a tool which uses helm3, arkade will check for a cached version and use that, otherwise it will download it on demand.
Did you accidentally run arkade as root? Running as root is not required, and will mean your KUBECONFIG environment variable will be ignored. You can revert this using the notes on release 0.1.18.
Both Issues and PRs have their own templates. Please fill out the whole template.
All commits must be signed-off as part of the Developer Certificate of Origin (DCO)
#contributors at slack.openfaas.io
An app is software or an add-on for your Kubernetes cluster.
A CLI or "tool" is a command line tool that you run directly on your own workstation or a CI runner.
|docker-registry-ingress||Install registry ingress with TLS|
|docker-registry||Install a Docker registry|
|nginx-inc||Install nginx-inc for OpenFaaS|
|metallb-arp||Install MetalLB in L2 (ARP) mode|
|loki||Install Loki for monitoring and tracing|
|nfs-provisioner||Install nfs subdir external provisioner|
|mqtt-connector||Install mqtt-connector for OpenFaaS|
|kanister||Install kanister for application-level data management|
|openfaas-ingress||Install openfaas ingress with TLS|
|chart||Install the specified helm chart|
|cron-connector||Install cron-connector for OpenFaaS|
|kafka||Install Confluent Platform Kafka|
|inlets-tcp-client||Install inlets PRO TCP client|
|kong-ingress||Install kong-ingress for OpenFaaS|
|opa-gatekeeper||Install Open Policy Agent (OPA) Gatekeeper|
|consul-connect||Install Consul Service Mesh|
|prometheus||Install Prometheus for monitoring|
|openfaas-loki||Install Loki-OpenFaaS and Configure Loki logs provider for OpenFaaS|
|portainer||Install portainer to visualise and manage containers|
|tekton||Install Tekton pipelines and dashboard|
|kafka-connector||Install kafka-connector for OpenFaaS|
|nats-connector||Install OpenFaaS connector for NATS|
There are 56 apps that you can install on your cluster.
Note to contributors, run
arkade install --print-tableto generate this list
|argocd||Declarative, GitOps continuous delivery tool for Kubernetes.|
|argocd-autopilot||An opinionated way of installing Argo-CD and managing GitOps repositories.|
|arkade||Portable marketplace for downloading your favourite devops CLIs and installing helm charts, with a single command.|
|autok3s||Run Rancher Lab's lightweight Kubernetes distribution k3s everywhere.|
|buildx||Docker CLI plugin for extended build capabilities with BuildKit.|
|butane||Translates human readable Butane Configs into machine readable Ignition Configs|
|caddy||Caddy is an extensible server platform that uses TLS by default|
|cilium||CLI to install, manage & troubleshoot Kubernetes clusters running Cilium.|
|civo||CLI for interacting with your Civo resources.|
|clusterawsadm||Kubernetes Cluster API Provider AWS Management Utility|
|clusterctl||The clusterctl CLI tool handles the lifecycle of a Cluster API management cluster|
|conftest||Write tests against structured configuration data using the Open Policy Agent Rego query language|
|cosign||Container Signing, Verification and Storage in an OCI registry.|
|cr||Hosting Helm Charts via GitHub Pages and Releases|
|crane||crane is a tool for interacting with remote images and registries|
|dagger||A portable devkit for CI/CD pipelines.|
|devspace||Automate your deployment workflow with DevSpace and develop software directly inside Kubernetes.|
|dive||A tool for exploring each layer in a docker image|
|docker-compose||Define and run multi-container applications with Docker.|
|doctl||Official command line interface for the DigitalOcean API.|
|eksctl||Amazon EKS Kubernetes cluster management|
|eksctl-anywhere||Run Amazon EKS on your own infrastructure|
|faas-cli||Official CLI for OpenFaaS.|
|firectl||Command-line tool that lets you run arbitrary Firecracker MicroVMs|
|flux||Continuous Delivery solution for Kubernetes powered by GitOps Toolkit.|
|flyctl||Command line tools for fly.io services|
|fzf||General-purpose command-line fuzzy finder|
|gh||GitHub’s official command line tool.|
|golangci-lint||Go linters aggregator.|
|gomplate||A flexible commandline tool for template rendering. Supports lots of local and remote datasources.|
|goreleaser||Deliver Go binaries as fast and easily as possible|
|grafana-agent||Grafana Agent is a telemetry collector for sending metrics, logs, and trace data to the opinionated Grafana observability stack.|
|grype||A vulnerability scanner for container images and filesystems|
|hadolint||A smarter Dockerfile linter that helps you build best practice Docker images|
|helm||The Kubernetes Package Manager: Think of it like apt/yum/homebrew for Kubernetes.|
|helmfile||Deploy Kubernetes Helm Charts|
|hey||Load testing tool|
|hostctl||Dev tool to manage /etc/hosts like a pro!|
|hubble||CLI for network, service & security observability for Kubernetes clusters running Cilium.|
|hugo||Static HTML and CSS website generator.|
|influx||InfluxDB’s command line interface (influx) is an interactive shell for the HTTP API.|
|inlets-pro||Cloud Native Tunnel for HTTP and TCP traffic.|
|inletsctl||Automates the task of creating an exit-server (tunnel server) on public cloud infrastructure.|
|istioctl||Service Mesh to establish a programmable, application-aware network using the Envoy service proxy.|
|jq||jq is a lightweight and flexible command-line JSON processor|
|just||Just a command runner|
|k0s||Zero Friction Kubernetes|
|k0sctl||A bootstrapping and management tool for k0s clusters|
|k10multicluster||Multi-cluster support for K10.|
|k10tools||Tools for evaluating and debugging K10.|
|k3d||Helper to run Rancher Lab's k3s in Docker.|
|k3sup||Bootstrap Kubernetes with k3s over SSH < 1 min.|
|k9s||Provides a terminal UI to interact with your Kubernetes clusters.|
|kail||Kubernetes log viewer.|
|kanctl||Framework for application-level data management on Kubernetes.|
|kgctl||A CLI to manage Kilo, a multi-cloud network overlay built on WireGuard and designed for Kubernetes.|
|kim||Build container images inside of Kubernetes. (Experimental)|
|kind||Run local Kubernetes clusters using Docker container nodes.|
|kops||Production Grade K8s Installation, Upgrades, and Management.|
|krew||Package manager for kubectl plugins.|
|kube-bench||Checks whether Kubernetes is deployed securely by running the checks documented in the CIS Kubernetes Benchmark.|
|kubebuilder||Framework for building Kubernetes APIs using custom resource definitions (CRDs).|
|kubecm||Easier management of kubeconfig.|
|kubeconform||A FAST Kubernetes manifests validator, with support for Custom Resources|
|kubectl||Run commands against Kubernetes clusters|
|kubectx||Faster way to switch between clusters.|
|kubens||Switch between Kubernetes namespaces smoothly.|
|kubescape||kubescape is the first tool for testing if Kubernetes is deployed securely as defined in Kubernetes Hardening Guidance by to NSA and CISA|
|kubeseal||A Kubernetes controller and tool for one-way encrypted Secrets|
|kubestr||Kubestr discovers, validates and evaluates your Kubernetes storage options.|
|kubetail||Bash script to tail Kubernetes logs from multiple pods at the same time.|
|kubeval||Validate your Kubernetes configuration files, supports multiple Kubernetes versions|
|kumactl||kumactl is a CLI to interact with Kuma and its data|
|kustomize||Customization of kubernetes YAML configurations|
|lazygit||A simple terminal UI for git commands.|
|linkerd2||Ultralight, security-first service mesh for Kubernetes.|
|mc||MinIO Client is a replacement for ls, cp, mkdir, diff and rsync commands for filesystems and object storage.|
|metal||Official Equinix Metal CLI|
|minikube||Runs the latest stable release of Kubernetes, with support for standard Kubernetes features.|
|mixctl||A tiny TCP load-balancer.|
|mkcert||A simple zero-config tool to make locally trusted development certificates with any names you'd like.|
|nats||Utility to interact with and manage NATS.|
|nats-server||Cloud native message bus and queue server|
|nerdctl||Docker-compatible CLI for containerd, with support for Compose|
|nova||Find outdated or deprecated Helm charts running in your cluster.|
|oh-my-posh||A prompt theme engine for any shell that can display kubernetes information.|
|opa||General-purpose policy engine that enables unified, context-aware policy enforcement across the entire stack.|
|operator-sdk||Operator SDK is a tool for scaffolding and generating code for building Kubernetes operators|
|osm||Open Service Mesh uniformly manages, secures, and gets out-of-the-box observability features.|
|pack||Build apps using Cloud Native Buildpacks.|
|packer||Build identical machine images for multiple platforms from a single source configuration.|
|polaris||Run checks to ensure Kubernetes pods and controllers are configured using best practices.|
|popeye||Scans live Kubernetes cluster and reports potential issues with deployed resources and configurations.|
|porter||With Porter you can package your application artifact, tools, etc. as a bundle that can distribute and install.|
|promtool||Prometheus rule tester and debugging utility|
|rekor-cli||Secure Supply Chain - Transparency Log|
|rpk||Kafka compatible streaming platform for mission critical workloads.|
|run-job||Run a Kubernetes Job and get the logs when it's done.|
|scaleway-cli||Scaleway CLI is a tool to help you pilot your Scaleway infrastructure directly from your terminal.|
|sops||Simple and flexible tool for managing secrets|
|stern||Multi pod and container log tailing for Kubernetes.|
|syft||CLI tool and library for generating a Software Bill of Materials from container images and filesystems|
|talosctl||The command-line tool for managing Talos Linux OS.|
|terraform||Infrastructure as Code for major cloud providers.|
|terragrunt||Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple Terraform modules|
|terrascan||Detect compliance and security violations across Infrastructure as Code.|
|tfsec||Security scanner for your Terraform code|
|tilt||A multi-service dev environment for teams on Kubernetes.|
|tkn||A CLI for interacting with Tekton.|
|trivy||Vulnerability Scanner for Containers and other Artifacts, Suitable for CI.|
|vagrant||Tool for building and distributing development environments.|
|vault||A tool for secrets management, encryption as a service, and privileged access management.|
|vcluster||Create fully functional virtual Kubernetes clusters - Each vcluster runs inside a namespace of the underlying k8s cluster.|
|viddy||A modern watch command. Time machine and pager etc.|
|waypoint||Easy application deployment for Kubernetes and Amazon ECS|
|yq||Portable command-line YAML processor.|
|There are 119 tools, use
Note to contributors, run
arkade get --output markdownto generate this list