The Koyeb CLI (Command Line Interface) is a powerful tool to manage your Koyeb serverless infrastructure directly from your terminal.
The CLI can be installed from pre-compiled binaries for macOS (darwin), Linux and Windows. You can download the appropriate version from the Releases page.
You can install the latest version of the Koyeb CLI on macOS using Homebrew:
brew install koyeb/tap/koyebYou can upgrade an existing installation of the Koyeb CLI running:
brew upgrade koyeb
To install the latest koyeb binary with go, simply run:
go get github.com/koyeb/koyeb-cli/cmd/koyeb
go install github.com/koyeb/koyeb-cli/cmd/koyebIf you need a go environment, follow the official Go installation documentation.
Generate an API token and run koyeb login to create a new configuration file.
➜ koyeb login
? Do you want to create a new configuration file in (/Users/kbot/.koyeb.yaml)? [y/N]
✗ Enter your api access token, you can create a new token here ( https://app.koyeb.com/account/api ): █****************************************************************
INFO[0006] Creating new configuration in /Users/kbot/.koyeb.yaml➜ koyeb --help
Koyeb CLI
Usage:
koyeb [command]
Available Commands:
apps Apps
completion Generate completion script
deployments Deployments
help Help about any command
instances Instances
login Login to your Koyeb account
secrets Secrets
services Services
version Get version
Flags:
-c, --config string config file (default is $HOME/.koyeb.yaml)
-d, --debug debug
--full show full id
-h, --help help for koyeb
-o, --output string output format (yaml,json,table)
--token string API token
--url string url of the api (default "https://app.koyeb.com")
Use "koyeb [command] --help" for more information about a command.koyeb has auto-completion support for bash, zsh and fish.
You can easily do source <(koyeb completion bash) to add completion to your current Bash session.
To load completions for all sessions, simply add the auto-completion script to your bash_completion.d folder.
On Linux:
koyeb completion bash > /etc/bash_completion.d/koyebOn MacOs:
koyeb completion bash > /usr/local/etc/bash_completion.d/koyebYou will need to start a new shell for this setup to take effect.
If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:
echo "autoload -U compinit; compinit" >> ~/.zshrcTo automatically load completions for all your shell session, execute once:
koyeb completion zsh > "${fpath[1]}/_koyeb"You will need to start a new shell for this setup to take effect.
You can easily run koyeb completion fish | source to add completions to your current Fish session.
To automatically load completions for all your shell session, execute once:
koyeb completion fish > ~/.config/fish/completions/koyeb.fishCheckout CONTRIBUTING.md
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent