Quickstart

Go from zero to a deployed function with the Volcano CLI — develop locally first, then push the same project to the cloud.

1. Install the CLI

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

Other methods (pnpm, Bun, Homebrew) are in installation.

2. Sign up

volcano signup

This creates your account and logs you in.

3. Scaffold a project

volcano init javascript      # also: nextjs, python, ruby

This creates a starter project with a sample function under volcano/functions/ and a volcano-config.yaml describing it.

4. Develop locally

Start a full Volcano stack on your machine:

volcano start
volcano status

While the local environment is running, the top-level commands act on it. Deploy the scaffolded function and invoke it:

volcano functions deploy --all
volcano functions list                       # see the deployed function's name
volcano functions invoke hello --payload '{"name":"Ada"}'

You'll get the function's JSON response. Edit volcano/functions/hello.js, redeploy, and invoke again to iterate — no cloud round-trip.

5. Deploy to the cloud

Create a cloud project and select it:

volcano projects create my-app
volcano use my-app

Prefix a command with cloud to target the cloud project explicitly:

volcano cloud functions deploy --all
volcano cloud functions invoke hello --payload '{"name":"Ada"}'

Your function now runs on Volcano's managed infrastructure. To deploy the whole project (functions, variables, databases, and more) from one manifest, use volcano config deploy — see declarative config.

What's next

For the full command set, see the CLI reference or run volcano <command> --help.