shipper settings set
shipper settings set
Section titled “shipper settings set”Usage: shipper settings set [options]
Set one setting in an explicitly selected scope
Arguments
Section titled “Arguments”| Argument | Required | Description | Choices |
|---|---|---|---|
| yes | settings key | - | |
| yes | JSON value or string | - |
| Long | Short | Value | Default | Description | Choices |
|---|---|---|---|---|---|
| —json | - | - | false | output the result as JSON | - |
| —user | - | - | - | write user-global settings | - |
| —repo | - | - | - | write repository settings | - |
| —personal | - | - | - | write personal repository settings | - |
| —skip-agent-verification | - | - | - | force the write past rejected or unavailable agent verification | - |
Examples
Section titled “Examples”Set a numeric user-global value parsed from JSON.
shipper settings set hookTimeoutMinutes 15 --userSet a repository-only value using string fallback parsing.
shipper settings set mirrorMode mirror-on --repoDefine local transport policy in committed repository settings.
shipper settings set transport none --repoCreate a machine-local repository override without modifying committed settings.
shipper settings set defaultBaseBranch integration --personalCommit merge-based feature-branch integration as shared repository behavior.
shipper settings set baseIntegration merge --repoOverride integration for a third-party repository whose committed settings cannot be changed.
shipper settings set baseIntegration merge --personalRaise the finite byte ceiling for reviews in the current repository.
shipper settings set reviewDiffCeilingBytes 750000 --personalExit Codes
Section titled “Exit Codes”| Code | When |
|---|---|
| 0 | The selected file is atomically written and the result is printed. |
| 1 | Scope selection, key validation, value validation, repository setup prerequisite, repository policy, personal identity, or writing fails. |
Constraints
Section titled “Constraints”- Exactly one of
--user,--repo, or--personalis required. - Values are parsed as JSON; only JSON parse failures fall back to the original string.
cliVersion,mirrorMode,transport,pullRequests, andreviewDeliveryrequire--repo.defaultBaseBranchaccepts--repoor--personaland rejects--user.baseIntegrationaccepts--repoor--personal, rejects--user, and accepts onlyrebaseormerge; personal scope is a third-party-repository escape hatch rather than a per-developer preference.reviewDiffCeilingBytesaccepts a finite positive whole number of bytes at--user,--repo, or--personalscope; its default is 500000 and it has no unlimited or disabled value.reviewDeliveryaccepts onlylocal;postis refused because Shipper always keeps pull-request reviews internally.- The complete candidate settings resolution, including inferred values and cross-setting dependency rules, is validated before atomic replacement; a correcting repository edit remains available when committed policy is already invalid.
- Repository-scoped changes require
shipper setup --repoto have created.shipper/settings.json; otherwise the change is not applied and may be retried after setup. - Missing user-global and personal settings files are created on demand.
- Changes to effective agent, model, or reasoning effort tuples are verified before writing; rejected and unavailable outcomes leave the file unchanged.
--skip-agent-verificationexplicitly stores changed agent settings without a passing probe and reports the bypass.- After repository setup creates
.shipper/settings.json, repository mutations do not require GitHub authentication or linkage. Repository-target setup supports either a GitHub-backed repository or a committed fully local repository with no transport; a non-GitHuboriginremains unsupported. Personal scope requires a resolvable personal settings identity.