Skip to content

shipper settings set

Usage: shipper settings set [options]

Set one setting in an explicitly selected scope

ArgumentRequiredDescriptionChoices
yessettings key-
yesJSON value or string-
LongShortValueDefaultDescriptionChoices
—json--falseoutput 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-

Set a numeric user-global value parsed from JSON.

Terminal window
shipper settings set hookTimeoutMinutes 15 --user

Set a repository-only value using string fallback parsing.

Terminal window
shipper settings set mirrorMode mirror-on --repo

Define local transport policy in committed repository settings.

Terminal window
shipper settings set transport none --repo

Create a machine-local repository override without modifying committed settings.

Terminal window
shipper settings set defaultBaseBranch integration --personal

Commit merge-based feature-branch integration as shared repository behavior.

Terminal window
shipper settings set baseIntegration merge --repo

Override integration for a third-party repository whose committed settings cannot be changed.

Terminal window
shipper settings set baseIntegration merge --personal

Raise the finite byte ceiling for reviews in the current repository.

Terminal window
shipper settings set reviewDiffCeilingBytes 750000 --personal
CodeWhen
0The selected file is atomically written and the result is printed.
1Scope selection, key validation, value validation, repository setup prerequisite, repository policy, personal identity, or writing fails.
  • Exactly one of --user, --repo, or --personal is required.
  • Values are parsed as JSON; only JSON parse failures fall back to the original string.
  • cliVersion, mirrorMode, transport, pullRequests, and reviewDelivery require --repo.
  • defaultBaseBranch accepts --repo or --personal and rejects --user.
  • baseIntegration accepts --repo or --personal, rejects --user, and accepts only rebase or merge; personal scope is a third-party-repository escape hatch rather than a per-developer preference.
  • reviewDiffCeilingBytes accepts a finite positive whole number of bytes at --user, --repo, or --personal scope; its default is 500000 and it has no unlimited or disabled value.
  • reviewDelivery accepts only local; post is 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 --repo to 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-verification explicitly 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-GitHub origin remains unsupported. Personal scope requires a resolvable personal settings identity.