RWX quickstart with Entire

If you're not already familiar with RWX, you may want to start with the general getting started guide. We automatically apply $100 of credits to every new account so you can explore RWX without commitment.

Install the RWX plugin

Visit your RWX organization's VCS integrations page, find Entire, and click Connect. Follow the instructions to install the RWX plugin on your Entire project and grant it access to your repositories.

The plugin lets RWX read run definitions from your .rwx directory, receive push and trail events, and report status checks.

Manage repository access and uninstall the plugin from your project on Entire. In RWX, the integration's settings let you refresh the repository list, pause webhook processing, or disable status checks. If a repository is missing, grant the plugin access on Entire, then click Refresh repositories in RWX.

Testing the Entire integration

Run definition

Create a file named .rwx/push.yml, commit, and push it to your Entire repository:

on:
  entire:
    push:

base:
  image: ubuntu:26.04
  config: rwx/base 1.2.0

tasks:
  - key: hello-world
    run: echo hello world

Entire status check

Take a look at the commit you just pushed in Entire. It should show an RWX status check. Follow the check's link to open the RWX UI and see the hello-world task.

See Status Checks to customize the check name, disable the default check, or group tasks into custom checks.

Cloning repositories

Entire requires the git-remote-entire helper and an ENTIRE_TOKEN; plain HTTPS Git authentication isn't supported. Use entire/install to install the CLI and helper, then pass that task as a use dependency of git/clone version 2.3.0 or later.

Use the entire:// clone URL from your repository and pass ${{ entire['YOUR_PROJECT/YOUR_REPO'].token }} as entire-token. The token is read-only and scoped to that connected repository. Replace the example URL below with your repository's URL, including its region host and path.

Update .rwx/push.yml to contain the following, then commit and push:

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

base:
  image: ubuntu:26.04
  config: rwx/base 1.2.0

tasks:
  - key: entire-cli
    call: entire/install 1.0.0

  - key: code
    use: entire-cli
    call: git/clone 2.3.0
    with:
      repository: entire://aws-us-east-2.entire.io/et/YOUR_PROJECT/YOUR_REPO
      ref: ${{ init.commit-sha }}
      entire-token: ${{ entire['YOUR_PROJECT/YOUR_REPO'].token }}

For subsequent Git operations, set preserve-git-dir: true on the clone task and supply ENTIRE_TOKEN in the later task's environment. The integration's token is read-only, so it can't push changes.

Next steps

For building a graph of tasks on top of your code task, see the CI reference workflow guide.

For triggering runs on trails as well as pushes, see Entire Triggers.