Deploy a Compose App

1. Install the Compose CLI Extension

If you already have the Goldsky CLI installed, you’ll just need to install the Compose extension.

goldsky compose install

If you don’t already have the Goldsky CLI installed you’ll need to start by installing that, then run the above command. If you run any goldsky compose <verb> before installing the extension, it prints an install hint and exits; it no longer auto-installs. For macOS/Linux:

curl https://goldsky.com | sh

For Windows:

npm install -g @goldskycom/cli

Windows users need to have Node.js and npm installed first. Download from nodejs.org if not already installed.

2. Create your app

Create a new Compose project with a working Bitcoin oracle example:

goldsky compose init

This command will:

Prompt you for a project name and create the app under that directory

Scaffold a complete example app with a working Bitcoin oracle

demo-app/
  compose.yaml              # the app manifest
  tsconfig.json             # TypeScript configuration
  .env                      # local environment variables
  .gitignore
  src/
    tasks/
      bitcoin-oracle.ts     # example task
    lib/
      utils.ts              # shared utilities

3. Start the app locally

cd into the project directory that was just created:

cd <your-project-name>

Start the app:

goldsky compose start --fork-chains

--fork-chains allows you to run a smart wallet locally. You can also use a private key wallet for your local Compose app. See more here. Your Compose application is now running! The server starts on port 4000 by default. If 4000 is taken, start walks up to port 4009 and prints Port 4000 is in use, using <port> instead.. To pin an exact port, pass -p, --port <port>; start fails fast if that port is taken. You can test triggering a task like so:

goldsky compose callTask bitcoin_oracle '{}' --env local

Updating the CLI

To update to the latest version, run the update command:

goldsky compose update

Compose

Guides

Reference

1. Install the Compose CLI Extension

2. Create your app

3. Start the app locally

Updating the CLI

​1. Install the Compose CLI Extension

​2. Create your app

​3. Start the app locally

​Updating the CLI

1. Install the Compose CLI Extension

2. Create your app

3. Start the app locally

Updating the CLI