Use Koyeb CLI to interact with the Koyeb serverless platform directly from the terminal.
The Koyeb CLI allows you to interact and manage all your Koyeb resources directly from the terminal. It provides a fast way to interact with Koyeb when you develop your projects.
Koyeb CLI is available as pre-compiled binaries for Linux, macOS and Windows. You can install it using the installers below, or download a release binary from the releases page. For more information on the available installation methods, you can check out this documentation
curl https://raw.githubusercontent.com/koyeb/koyeb-cli/master/install.sh | sh
Before getting started using the CLI, you need to create a Koyeb API access token. In the Koyeb control panel, go to your account settings. Click the Create API access token button, a modal opens and asks for a token name and description. Fill the name input with the name you want to give to your API access token, i.e. "Koyeb CLI token" and validate.
Your API access token appears. Save the API access token in a safe place, we will use it to login from the Koyeb CLI.
In your terminal, run the following command to login from the Koyeb CLI and enter your API access token:
$koyeb login Enter your api credential: ******************
To create a Koyeb app and deploy your first service running the Koyeb demo, execute:
koyeb app init my-app --docker koyeb/demo --ports 3000:http --routes /:3000
To retrieve your Koyeb App information such as the App URL, the services running inside the App, etc. run:
$koyeb app describe my-app App id 230b41a1-404e-4ae1-8079-9731bf3e0000 name my-app domains my-app-org.koyeb.app updated_at 2021-07-06 08:14:39.551634 +0000 UTC Services ID NAME STATUS UPDATED AT 23ec9a9d-ea20-4556-ab55-548dd6000000 my-service ACTIVE 2021-07-06 08:32:10.539081 +0000 UTC
To learn more about the CLI reference, check out the CLI reference.