rwx sandbox init

Initialize a sandbox configuration file.

Usage

rwx sandbox init [output-file] [flags]

Description

Creates a new sandbox configuration file with a basic template to help you get started with RWX sandboxes. A sandbox starting point will typically look like this:

on:
  cli:
    init:
      commit-sha: ${{ event.git.sha }}

base:
  image: ubuntu:24.04
  config: rwx/base 1.0.0

tasks:
  - key: code
    call: git/clone 2.0.3
    with:
      preserve-git-dir: true
      repository: https://github.com/your-org/your-repo.git
      ref: ${{ init.commit-sha }}
      github-token: ${{ github.token }}

  # Any other dependencies should be defined here and then `use`d by the sandbox task

  - key: sandbox
    use: code
    run: rwx-sandbox

If you're new to setting up run definitions with RWX, you can reference the CI reference workflow for RWX for more examples.

Arguments

[output-file]

The path where the configuration file should be created. Defaults to .rwx/sandbox.yml.

Global Options

--output <format>

Output format: text or json. Defaults to text.

--access-token <token>

The access token for RWX. Defaults to the value of the $RWX_ACCESS_TOKEN environment variable.