FalseGreen installation

Choose your path.

Core for the build loop. PR Gate for merge checks.

Choose the path that fits your workflow: connect an existing coding agent to FalseGreen Core, or add the separate PR Gate when CI should check acceptance before a pull request can merge.

FalseGreen Core

Connect your coding agent.

Core is the path for creating and verifying FalseGreen Jobs.

  1. 01
    Create an Account and buy a Job.
  2. 02
    Install the client and log in.
    cargo install falsegreen
    falsegreen login --token YOUR_FALSEGREEN_KEY

    Get your key from your Account. Do not put it in your MCP configuration.

  3. 03
  4. 04
    Restart your coding agent.

    It can now create Jobs, freeze requirements, verify the work, and return the report.

FalseGreen PR Gate

Check acceptance before merge.

PR Gate is a separate CI client. It checks the current pull-request head against acceptance already issued by FalseGreen Core. It does not create Jobs or perform verification.

  1. 01
    Install PR Gate.
    cargo install falsegreen-gate

    Published on crates.io.

  2. 02
    Save your API key as a CI secret.

    The Gate authenticates with your organization's FalseGreen API key — the same key you use with falsegreen login. Save it in your CI secret store as FALSEGREEN_KEY. Get the key from your Account.

  3. 03
    Run Gate in CI.
    falsegreen-gate

    Run it after checkout. The client detects the repository, request, and exact head from the git checkout and CI provider (explicit flags are available when detection is not enough), then require the resulting check in branch protection.

Choose your CI provider.

The same Gate command works across providers. Open yours for the smallest example.

GitHub Actions

Run the Gate on pull_request and pass the job workflow context.

                        - name: Run FalseGreen PR Gate
  env:
    FALSEGREEN_KEY: ${{ secrets.FALSEGREEN_KEY }}
    FALSEGREEN_GITHUB_JOB_WORKFLOW_REPOSITORY: ${{ job.workflow_repository }}
    FALSEGREEN_GITHUB_JOB_WORKFLOW_REF: ${{ job.workflow_ref }}
    FALSEGREEN_GITHUB_JOB_WORKFLOW_SHA: ${{ job.workflow_sha }}
    FALSEGREEN_GITHUB_JOB_WORKFLOW_FILE_PATH: ${{ job.workflow_file_path }}
  run: falsegreen-gate
                      
GitLab CI

Add the command to a merge-request job. GitLab supplies the request and source context.

                        pr-gate:
  variables:
    GIT_DEPTH: 0
  script:
    - falsegreen-gate
                      
Buildkite

Add a pull-request step. Buildkite supplies the repository, request, and commit context.

                        steps:
  - label: "PR Gate"
    command: "falsegreen-gate"
                      
Jenkins

Run the command in the pull-request stage of a multibranch job.

                        stage('FalseGreen PR Gate') {
  steps {
    sh 'falsegreen-gate'
  }
}
                      
CircleCI

Run the command after checkout in the pull-request job.

                        - run:
    name: FalseGreen PR Gate
    command: falsegreen-gate
                      
Drone

Add a pull-request step after checkout. Keep the Gate binary in the runner image or distribution.

                        steps:
  - name: pr-gate
    commands:
      - falsegreen-gate
                      
Azure DevOps

Run the command in the pull-request pipeline. Azure supplies the request and source context.

                        - script: falsegreen-gate
  displayName: FalseGreen PR Gate
                      
Generic CI

If your provider is not detected, set the explicit repository, request, and exact head values.

                        export FALSEGREEN_REPOSITORY="host/org/repository"
export FALSEGREEN_PR_ID="123"
export FALSEGREEN_HEAD="exact-40-character-commit-sha"
falsegreen-gate
                      

How they fit together

Your coding agent builds the work. FalseGreen creates the acceptance. PR Gate checks it.