Skip to content

Commit 880d06f

Browse files
Brooooooklynclaude
andcommitted
docs(cli): correct non-interactive github connect flag requirements
The connect docs contradicted themselves: the --repo row said it was required only for all-repo installs, while the CI paragraph said all flags were always required in non-TTY. Neither matched the code, which auto-picks a sole installation / sole selected repo (server-authoritative and server-validated) and requires a flag only when ambiguous, for all-repo, or for --branch. Document the actual fail-closed-on-ambiguity behavior. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 3fd474c commit 880d06f

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

‎docs/reference/cli.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -594,17 +594,17 @@ Connect a GitHub repository to a Void project for automatic deploys. On every pu
594594

595595
**Options**
596596

597-
| Flag | Description |
598-
| --------------------- | ----------------------------------------------------------------------------- |
599-
| `--project <name>` | Project name (alias for the positional argument) |
600-
| `--installation <id>` | GitHub App installation ID (required when you have multiple installations) |
601-
| `--repo <owner/repo>` | Repository full name — required when the installation has access to all repos |
602-
| `--branch <name>` | Branch to deploy from — **required in non-interactive mode** |
603-
| `--executor <type>` | Build executor: `container` (default) or `github_actions` |
597+
| Flag | Description |
598+
| --------------------- | ------------------------------------------------------------------------------- |
599+
| `--project <name>` | Project name (alias for the positional argument) |
600+
| `--installation <id>` | GitHub App installation ID (required when you have multiple installations) |
601+
| `--repo <owner/repo>` | Repository full name — required unless the installation grants exactly one repo |
602+
| `--branch <name>` | Branch to deploy from — **required in non-interactive mode** |
603+
| `--executor <type>` | Build executor: `container` (default) or `github_actions` |
604604

605605
**Non-interactive use (CI)**
606606

607-
All of `--project` (or positional), `--installation`, `--repo`, and `--branch` must be supplied explicitly when stdin is not a TTY. Use `void github installations` to discover the `installation_id`.
607+
When stdin is not a TTY, `void github connect` never prompts — it fails closed and names any flag it needs. `--branch` is always required. `--project` must be resolvable (positional / `--project` / `VOID_PROJECT` / linked `.void/project.json`). `--installation` is required only when your account has more than one installation; otherwise the sole installation is used. `--repo` is required when the installation grants access to all repos or to more than one selected repo; when it grants exactly one repo that repo is used automatically. Use `void github installations` to discover the `installation_id`.
608608

609609
```
610610
void github connect my-app \

0 commit comments

Comments
 (0)