Console
Documentation menu

Start

Quickstart

Go from a new account to your first generated image and a deployed instance in about ten minutes.

Before you begin

  • A ClockingCloud account. Create one with email and password or Google.
  • Prepaid credit. The minimum top-up is $10. See Billing.
  • macOS or Linux with Homebrew. On Windows, use WSL 2.

1. Install the CLI

Terminal
brew install clockingcloud/tap/clockingcloud
clockingcloud version

The package installs the clockingcloud command. Every example in these docs uses it.

2. Sign in

Terminal
clockingcloud login
clockingcloud whoami

clockingcloud login opens your browser, you approve the request, and the CLI stores a credential locally. On a machine without a browser run clockingcloud login --device.

3. Generate your first image

Terminal
clockingcloud run z-image-turbo \
  --prompt "a ceramic mug on a linen table, soft window light" \
  --out ./shots

The CLI starts a GPU, loads the model, generates the image, writes it to ./shots, and releases the GPU. You pay for the seconds the GPU was busy. The first run of a model can take longer because its weights are cached on first use. Later runs are warm.

4. Describe an instance as code

Create clockingcloud.yaml in your project. It is the same file you use locally, in review, and in CI/CD.

clockingcloud.yaml
name: product-shots
model: z-image-turbo
gpu: auto
scale:
  min: 0
  max: 8
idle_timeout: 60s

setup:
  - pip install -r requirements.txt

volumes:
  - name: assets
    mount: /data
    mode: ro
  - name: renders
    mount: /out
Terminal
clockingcloud plan
clockingcloud deploy -f clockingcloud.yaml
clockingcloud status product-shots

clockingcloud plan validates the file and prints the GPU and estimated cost without creating anything. With scale.min: 0 the instance costs nothing until the first request arrives.

5. Check your spend and stop

Terminal
clockingcloud balance
clockingcloud usage --since 1d
clockingcloud stop product-shots

Stopping releases the GPUs immediately. The definition and volumes remain, so clockingcloud start product-shots brings it back.

Where to go next

Something unclear or missing? Email hello@clockingcloud.com.