> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# bijection branch

> Fork live data, try changes, compare, apply or discard

## bijection branch

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Manage branches of the selected deployment. A branch is a fork of the deployment's committed data at a pinned revision; external calls made on it are held and never leave it.

Create: bijection branch create what-if
Compare: bijection branch compare what-if orders:list
Review: bijection branch review what-if
Finish: bijection branch finish what-if --review <review-id>

Usage:
  bijection branch [flags]
  bijection branch [command]

Available Commands:
  compare     Run a query on the branch and on its parent and compare the results
  create      Fork the deployment's committed data at its current revision
  discard     Discard the branch and everything committed on it
  extend      Move the branch expiry
  finish      Publish the reviewed program, then apply only its selected operations. Retry the same review after an interrupted response.
  list        List branches you can open
  refresh     Refresh the same branch from live, preserving its code and replayable operations. Retry the same command after interruption.
  review      Review the branch program on current live data. Test operations stay on the branch unless explicitly included.
  share       Let users open the branch with their own identity
  status      Show one branch
  unshare     Stop letting users open the branch with their own identity

Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
  -h, --help                help for branch
      --prod                Manage branches of this project's default production deployment.

Use "bijection branch [command] --help" for more information about a command.
```

## bijection branch compare

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Run a query on the branch and on its parent and compare the results

Usage:
  bijection branch compare <key> <functionPath> [flags]

Flags:
      --args string       Query arguments as a JSON object (default "{}")
  -h, --help              help for compare
      --identity string   Inspect as this user with a JSON-formatted UserIdentity. Administrative impersonation cannot authorize replay or refresh.
      --json              Output as JSON

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch create

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Fork the deployment's committed data at its current revision

Usage:
  bijection branch create <key> [flags]

Flags:
      --empty             Start from an empty log instead of live data
  -h, --help              help for create
      --show-admin-key    Print the branch admin key and how to deploy to the branch
      --ttl-hours float   Hours until the branch expires

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch discard

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Discard the branch and everything committed on it

Usage:
  bijection branch discard <key> [flags]

Flags:
  -h, --help   help for discard

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch extend

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Move the branch expiry

Usage:
  bijection branch extend <key> [flags]

Flags:
  -h, --help              help for extend
      --ttl-hours float   Hours from now until the branch expires

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch finish

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Publish the reviewed program, then apply only its selected operations. Retry the same review after an interrupted response.

Usage:
  bijection branch finish <key> [flags]

Flags:
  -h, --help            help for finish
      --json            Output as JSON
      --review string   Receipt returned by branch review

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch list

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
List branches you can open

Usage:
  bijection branch list [flags]

Flags:
  -h, --help   help for list
      --json   Output as JSON

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch refresh

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Refresh the same branch from live, preserving its code and replayable operations. Retry the same command after interruption.

Usage:
  bijection branch refresh <key> [flags]

Flags:
      --cancel   Cancel the pending refresh and keep the current branch
  -h, --help     help for refresh
      --json     Output as JSON

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch review

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Review the branch program on current live data. Test operations stay on the branch unless explicitly included.

Usage:
  bijection branch review <key> [flags]

Flags:
  -h, --help                 help for review
      --include-operations   Include your ready test operations as an ordered batch for live
      --json                 Output as JSON

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch share

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Let users open the branch with their own identity

Usage:
  bijection branch share <key> <principal...> [flags]

Flags:
  -h, --help   help for share

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch status

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Show one branch

Usage:
  bijection branch status <key> [flags]

Flags:
  -h, --help              help for status
      --identity string   Inspect as this user with a JSON-formatted UserIdentity. Administrative impersonation cannot authorize replay or refresh.
      --json              Output as JSON
      --show-admin-key    Print the branch admin key and how to deploy to the branch

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```

## bijection branch unshare

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Stop letting users open the branch with their own identity

Usage:
  bijection branch unshare <key> <principal...> [flags]

Flags:
  -h, --help   help for unshare

Global Flags:
      --deployment string   Manage branches of a specific deployment. Accepts:
                            • a deployment name (e.g. joyful-capybara-123)
                            • a deployment reference (e.g. dev/james, staging)
                            • dev (for your personal dev deployment)
                            • prod (for your project’s default production deployment).
                            You can also select deployments in other projects with project-slug:reference.
      --prod                Manage branches of this project's default production deployment.
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.