Skip to main content
WebguneWebguneBetaDocs
StatusSupport
Introduction
Introduction to WebguneCreating an accountCreating your first projectExploring the dashboard

Deployment

Deploying from GitHubDeploying a Docker imageHow builds workDeployments and rollbackEnvironment variablesCustom start command

Web apps

Web applicationsSupported frameworksNext.jsReact / ViteNode.jsPythonPHPGo

Bots & workers

Discord botsWorkers

Docker

DockerWriting a DockerfilePublic Docker images

Databases

DatabasesPostgreSQLMySQLMariaDBMongoDBRedis

Observability

Logs and monitoringWeb terminal

Scaling

AutoscalingPersistent volumesBackups and restore
Deploying a templateTemplate catalog
Free subdomainsCustom domainsBuying a domainHosting DNS for a domain bought elsewhereManaging your DNS recordsSSL certificatesRedirects
Shared projectsRoles and permissionsReal-time collaboration
Continuous deploymentThe kx712.yml fileVS Code extension
Plans and pricingPayments and invoicesAccount or per-project subscription
API referenceAPI keysWebgune CLIMCP serverJavaScript / TypeScript SDK
Support ticketsStatus pageAI assistant
FAQLimits and resourcesAccount security
© 2026 WebguneStatusSupportPricingBack to the site
HomeAPIWebgune CLI

Webgune CLI

Updated on October 27, 2026

Webgune CLI

The official webgune CLI lets you manage your projects, services, deployments, and invoices directly from the terminal.

Installation

bun add -g webgune
# or
npm install -g webgune

Node.js 18 or higher is required.

Authentication

webgune login

Without options, webgune login opens your browser, as the VS Code extension does, to authorize the CLI on your logged-in account. An API key (prefix wgk_) is created automatically with the necessary scopes (projects, services, domains:read, billing) and returned to the CLI via a local server (127.0.0.1). Nothing to copy-paste.

For scripted use (CI, browserless container), pass an existing key directly. Create it in the dashboard under Settings → API keys:

webgune login --key wgk_xxxxxxxx

The key is stored in ~/.webgune/config.json. You can also use environment variables, convenient in CI:

export WEBGUNE_API_KEY=wgk_xxxxxxxx
export WEBGUNE_API_URL=https://api.webgune.cloud   # optional

Commands

Projects

webgune projects list
webgune projects create mon-projet
webgune projects delete <id>

Services

webgune services list                    # all your services
webgune services list --project <id>    # filtered by project
webgune services info <id>              # full details
webgune services logs <id> --tail 500   # runtime logs
webgune services redeploy <id>          # rebuild + redeploy
webgune services restart <id>
webgune services stop <id>
webgune services start <id>

Deployments

webgune services deployments <id>                 # history
webgune services rollback <serviceId> <deployId>  # rollback

Billing

webgune billing plans                    # pricing grid
webgune billing subscription             # your subscriptions (account + per-project dedicated) and SEPA mandate status
webgune billing invoices                 # your invoices
webgune billing cancel                   # cancel the account subscription (effective at end of period)
webgune billing cancel --project <id>    # cancel a project-dedicated subscription

In accordance with the Terms of Service, cancelling a plan takes effect at the end of the already-paid period. Your services remain active until then. Cancellation is refused if an invoice is pending payment.

Domains

webgune domains list

JSON output

All listing commands accept --json for raw output usable in scripts:

webgune services list --json | jq '.[].name'

See also

  • MCP server: control webgune from Claude or any MCP client.
  • API reference: the underlying HTTP API.
PreviousAPI keysNextMCP server

On this page

InstallationAuthenticationCommandsProjectsServicesDeploymentsBillingDomainsJSON outputSee also