volcano-cli

module
v0.34.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2026 License: Apache-2.0

README

Volcano CLI

Volcano is a hosting platform for building applications with functions, databases, and authentication. Deploy backend logic, provision PostgreSQL databases, and add user authentication—all through a unified API. The volcano CLI helps you scaffold, run, and manage Volcano projects from your terminal.

Quickstart

Install with npm:

npm install -g @volcano.dev/cli
volcano --help

Or install with pnpm:

pnpm add -g @volcano.dev/cli
volcano --help

Or install with Bun:

bun add -g @volcano.dev/cli
volcano --help

Or install with Homebrew:

brew install Kong/volcano/volcano
volcano --help

Or install manually:

curl -fsSL https://github.com/Kong/volcano-cli/releases/latest/download/install.sh | bash
volcano --help

Create a project directory and start local development:

mkdir volcano-quickstart
cd volcano-quickstart
volcano init javascript
volcano start
volcano variables deploy
volcano functions deploy --all
volcano config deploy
volcano migrations deploy --all -d app

volcano init without a template creates a base scaffold (environment files, migrations directory, and README). Use a template to add language-specific files: javascript (aliases: js, node, nodejs), nextjs, python, or ruby.

More detail lives in docs/:

Contributing

See CONTRIBUTING.md for local workflows, generated-code guidance, building from source, release notes, and pull request expectations. Participation is governed by CODE_OF_CONDUCT.md.

If you believe you have found a security vulnerability, do not open a public issue. Follow SECURITY.md instead.

License

Volcano CLI is licensed under the Apache License, Version 2.0. See LICENSE.

Directories

Path Synopsis
cmd
volcano command
Volcano is the CLI entry point.
 Volcano is the CLI entry point.
internal
accesstoken
Package accesstoken holds the project access token workflows behind the volcano access-tokens subcommands.
 Package accesstoken holds the project access token workflows behind the volcano access-tokens subcommands.
api
Package api is the HTTP client for the Volcano cloud API.
 Package api is the HTTP client for the Volcano cloud API.
apiclient
Package apiclient provides primitives to interact with the openapi HTTP API.
 Package apiclient provides primitives to interact with the openapi HTTP API.
archive
Package archive contains shared helpers for working with tar.gz archives produced by the CLI: byte-size formatting and multipart upload framing.
 Package archive contains shared helpers for working with tar.gz archives produced by the CLI: byte-size formatting and multipart upload framing.
auth
Package auth implements the device-code login flow against the cloud API.
 Package auth implements the device-code login flow against the cloud API.
cmd/accesstokens
Package accesstokens wires the volcano access-tokens subcommands.
 Package accesstokens wires the volcano access-tokens subcommands.
cmd/auth
Package auth wires the volcano login/logout/whoami commands.
 Package auth wires the volcano login/logout/whoami commands.
cmd/cloud
Package cloud wires commands that target the hosted Volcano API.
 Package cloud wires commands that target the hosted Volcano API.
cmd/cmdutil
Package cmdutil contains shared Cobra command helpers.
 Package cmdutil contains shared Cobra command helpers.
cmd/config
Package config wires the config command tree for declarative project configuration.
 Package config wires the config command tree for declarative project configuration.
cmd/databases
Package databases wires the volcano databases subcommands.
 Package databases wires the volcano databases subcommands.
cmd/databases/backup
Package backup wires the volcano databases backups, restore, and backup-schedule subcommands.
 Package backup wires the volcano databases backups, restore, and backup-schedule subcommands.
cmd/databases/branch
Package branch wires the volcano databases branches subcommands.
 Package branch wires the volcano databases branches subcommands.
cmd/databases/migration
Package migration runs SQL migrations against a Volcano database connection.
 Package migration runs SQL migrations against a Volcano database connection.
cmd/docs
Package docs wires the `volcano docs` command group: sync, search, get, and list over the Volcano documentation corpus.
 Package docs wires the `volcano docs` command group: sync, search, get, and list over the Volcano documentation corpus.
cmd/durable
Package durable wires the volcano durable subcommands.
 Package durable wires the volcano durable subcommands.
cmd/durable/executions
Package executions wires the volcano durable executions subcommands.
 Package executions wires the volcano durable executions subcommands.
cmd/durable/schedulers
Package schedulers wires the volcano durable schedulers subcommands.
 Package schedulers wires the volcano durable schedulers subcommands.
cmd/frontends
Package frontends wires the volcano frontends subcommands.
 Package frontends wires the volcano frontends subcommands.
cmd/functions
Package functions wires the volcano functions subcommands.
 Package functions wires the volcano functions subcommands.
cmd/functions/schedulers
Package schedulers wires the volcano functions schedulers subcommands.
 Package schedulers wires the volcano functions schedulers subcommands.
cmd/git
Package git wires the volcano git subcommands.
 Package git wires the volcano git subcommands.
cmd/init
Package initcmd wires the volcano init command.
 Package initcmd wires the volcano init command.
cmd/local
Package local wires commands that target the local development server.
 Package local wires commands that target the local development server.
cmd/localmode
Package localmode wires top-level local-mode environment commands.
 Package localmode wires top-level local-mode environment commands.
cmd/project
Package project wires the volcano project subcommands.
 Package project wires the volcano project subcommands.
cmd/root
Package root assembles the top-level volcano command and its subcommands.
 Package root assembles the top-level volcano command and its subcommands.
cmd/setup
Package setupcmd wires the volcano setup command.
 Package setupcmd wires the volcano setup command.
cmd/storage
Package storage provides storage commands.
 Package storage provides storage commands.
cmd/storage/bucket
Package bucket provides storage bucket commands.
 Package bucket provides storage bucket commands.
cmd/storage/object
Package object provides storage object commands.
 Package object provides storage object commands.
cmd/storage/policy
Package policy provides storage policy commands.
 Package policy provides storage policy commands.
cmd/upgrade
Package upgrade implements the top-level CLI self-upgrade command.
 Package upgrade implements the top-level CLI self-upgrade command.
cmd/variables
Package variables wires the volcano variables subcommands.
 Package variables wires the volcano variables subcommands.
config
Package config loads and persists the CLI configuration in ~/.volcano/config.json.
 Package config loads and persists the CLI configuration in ~/.volcano/config.json.
confirm
Package confirm prompts the user for yes/no confirmation on stdin.
 Package confirm prompts the user for yes/no confirmation on stdin.
database
Package database holds shared types and helpers for the databases subcommands.
 Package database holds shared types and helpers for the databases subcommands.
dataplane
Package dataplane obtains project data-plane credentials for cloud commands.
 Package dataplane obtains project data-plane credentials for cloud commands.
docs
Package docs implements the `volcano docs` subsystem: fetching Volcano documentation from a configurable GitHub source into a local cache and searching it with a small, dependency-free BM25 index.
 Package docs implements the `volcano docs` subsystem: fetching Volcano documentation from a configurable GitHub source into a local cache and searching it with a small, dependency-free BM25 index.
durable
Package durable performs authenticated Volcano durable function workflows.
 Package durable performs authenticated Volcano durable function workflows.
envfile
Package envfile parses .env files into key/value pairs.
 Package envfile parses .env files into key/value pairs.
frontend
Package frontend builds and packages frontend project archives for upload.
 Package frontend builds and packages frontend project archives for upload.
function
Package function builds and packages function archives for upload.
 Package function builds and packages function archives for upload.
gitconnect
Package gitconnect binds the current project to a GitHub repository.
 Package gitconnect binds the current project to a GitHub repository.
ignore
Package ignore decides which files to skip when packaging a project tree.
 Package ignore decides which files to skip when packaging a project tree.
localgit
Package localgit reads the local Git repository through the git binary.
 Package localgit reads the local Git repository through the git binary.
localmode
Package localmode contains the standalone CLI's local-mode contract.
 Package localmode contains the standalone CLI's local-mode contract.
logfollow
Package logfollow contains shared CLI log stream follow loops.
 Package logfollow contains shared CLI log stream follow loops.
mcp
Package mcp implements a minimal, dependency-free Model Context Protocol server over stdio (newline-delimited JSON-RPC 2.0).
 Package mcp implements a minimal, dependency-free Model Context Protocol server over stdio (newline-delimited JSON-RPC 2.0).
output
Package output formats command results for human and machine consumers.
 Package output formats command results for human and machine consumers.
project
Package project resolves and persists the currently selected Volcano project.
 Package project resolves and persists the currently selected Volcano project.
projectconfig
Package projectconfig handles declarative project configuration manifests (volcano-config.yaml).
 Package projectconfig handles declarative project configuration manifests (volcano-config.yaml).
projectinit
Package projectinit creates the on-disk Volcano project scaffold.
 Package projectinit creates the on-disk Volcano project scaffold.
runtime
Package runtime exposes process and timing dependencies for command tests.
 Package runtime exposes process and timing dependencies for command tests.
session
Package session resolves the authenticated client and active project for a command run.
 Package session resolves the authenticated client and active project for a command run.
setup
Package setup installs Volcano agent skills/plugins into the coding-agent harnesses present on the machine.
 Package setup installs Volcano agent skills/plugins into the coding-agent harnesses present on the machine.
storage
Package storage performs authenticated Volcano storage workflows.
 Package storage performs authenticated Volcano storage workflows.
theme
Package theme is the single home for the Volcano CLI color identity: the palette, the color-enable gate (NO_COLOR + real TTY), and the small string helpers commands use to style output.
 Package theme is the single home for the Volcano CLI color identity: the palette, the color-enable gate (NO_COLOR + real TTY), and the small string helpers commands use to style output.
update
Package update checks for and installs Volcano CLI releases.
 Package update checks for and installs Volcano CLI releases.
variable
Package variable holds shared types and helpers for the variables subcommands.
 Package variable holds shared types and helpers for the variables subcommands.
version
Package version exposes build-time identifiers injected via -ldflags.
 Package version exposes build-time identifiers injected via -ldflags.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.