> ## 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 ruleset

> View and manage live's opt-in protection rules

## bijection ruleset

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Live is unprotected by default: anyone with write access merges into it. A ruleset makes it protected: each domain names required reviewers for its source owners (as CODEOWNERS), the approvals it needs and its required checks; people on the bypass list merge without them (pr merge --admin); stale approvals are dismissed unless turned off.

A ruleset file is {"domains": [...], "bypass": ["issuer|subject"], "dismiss_stale_approvals": true}.

Usage:
  bijection ruleset [flags]
  bijection ruleset [command]

Available Commands:
  check       Show the rules that apply to merging into a branch for you
  create      Protect live with its first ruleset, under deployment authority
  edit        Replace live's ruleset after a fresh re-authentication
  list        List the rulesets that protect this deployment's branches
  view        View live's ruleset

Flags:
      --as string           Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --deployment string   Inspect rulesets on 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 ruleset
      --help-all            Show all commands and options, including administrative controls.
      --help-json           Print command input and output schemas as JSON without executing it.
      --url string          Inspect rulesets on a private deployment at this explicit origin.

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

## bijection ruleset check

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Show the rules that apply to merging into a branch for you

Usage:
  bijection ruleset check <branch> [flags]

Flags:
      --format string   Output format; JSON preserves exact values. (pretty, json) (default "pretty")
  -h, --help            help for check
      --help-all        Show all commands and options, including administrative controls.
      --help-json       Print command input and output schemas as JSON without executing it.

Global Flags:
      --as string           Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --deployment string   Inspect rulesets on 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.
      --url string          Inspect rulesets on a private deployment at this explicit origin.
```

## bijection ruleset create

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Protect live with its first ruleset, under deployment authority

Usage:
  bijection ruleset create <ruleset-file> [flags]

Flags:
      --format string   Output format; JSON preserves exact values. (pretty, json) (default "pretty")
  -h, --help            help for create
      --help-all        Show all commands and options, including administrative controls.
      --help-json       Print command input and output schemas as JSON without executing it.

Global Flags:
      --as string           Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --deployment string   Inspect rulesets on 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.
      --url string          Inspect rulesets on a private deployment at this explicit origin.
```

## bijection ruleset edit

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
Replace live's ruleset after a fresh re-authentication

Usage:
  bijection ruleset edit [ruleset-file] [flags]

Flags:
      --approve string      Approve another reviewer's pending ruleset change instead of proposing one
      --format string       Output format; JSON preserves exact values. (pretty, json) (default "pretty")
  -h, --help                help for edit
      --help-all            Show all commands and options, including administrative controls.
      --help-json           Print command input and output schemas as JSON without executing it.
      --request-id string   Stable request identity of at most 120 characters; retry with the same value after an unconfirmed response

Global Flags:
      --as string           Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --deployment string   Inspect rulesets on 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.
      --url string          Inspect rulesets on a private deployment at this explicit origin.
```

## bijection ruleset list

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
List the rulesets that protect this deployment's branches

Usage:
  bijection ruleset list [flags]

Flags:
      --format string   Output format; JSON preserves exact values. (pretty, json) (default "pretty")
  -h, --help            help for list
      --help-all        Show all commands and options, including administrative controls.
      --help-json       Print command input and output schemas as JSON without executing it.

Global Flags:
      --as string           Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --deployment string   Inspect rulesets on 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.
      --url string          Inspect rulesets on a private deployment at this explicit origin.
```

## bijection ruleset view

```text theme={"theme":{"light":"github-light-default","dark":"github-dark-default"}}
View live's ruleset

Usage:
  bijection ruleset view [branch] [flags]

Flags:
      --format string   Output format; JSON preserves exact values. (pretty, json) (default "pretty")
  -h, --help            help for view
      --help-all        Show all commands and options, including administrative controls.
      --help-json       Print command input and output schemas as JSON without executing it.

Global Flags:
      --as string           Act as a person, such as alice, on a development, preview or local deployment. Production refuses development identities.
      --deployment string   Inspect rulesets on 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.
      --url string          Inspect rulesets on a private deployment at this explicit origin.
```


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