core/cli
8
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions 1
cli/pkg/updater/docs/configuration.md
Snider 4e02d5bc97 refactor: bring external packages home and restructure 
- Imported packages from separate repos:
  - github.com/Snider/config -> pkg/config
  - github.com/Snider/display -> pkg/display
  - github.com/Snider/help -> pkg/help
  - github.com/Snider/i18n -> pkg/i18n
  - github.com/Snider/updater -> pkg/updater
- Moved core code from root to pkg/core
- Flattened nested package structures
- Updated all import paths to github.com/Snider/Core/pkg/*
- Added Display interface to Core
- Updated go.work for workspace modules

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-15 15:30:43 +00:00

1.9 KiB
Raw Blame History

Configuration

The updater library is highly configurable via the UpdateServiceConfig struct.

UpdateServiceConfig

When creating a new UpdateService, you pass a UpdateServiceConfig struct. Here are the available fields:

Field Type Description
RepoURL string The URL to the repository for updates. Can be a GitHub repository URL (e.g., https://github.com/owner/repo) or a base URL for a generic HTTP update server.
Channel string Specifies the release channel to track (e.g., "stable", "prerelease"). This is only used for GitHub-based updates.
CheckOnStartup StartupCheckMode Determines the behavior when the service starts. See Startup Modes below.
ForceSemVerPrefix bool Toggles whether to enforce a 'v' prefix on version tags for display and comparison. If true, a 'v' prefix is added if missing.
ReleaseURLFormat string A template for constructing the download URL for a release asset. The placeholder {tag} will be replaced with the release tag.

Startup Modes

The CheckOnStartup field can take one of the following values:

  • updater.NoCheck: Disables any checks on startup.
  • updater.CheckOnStartup: Checks for updates on startup but does not apply them.
  • updater.CheckAndUpdateOnStartup: Checks for and applies updates on startup.

CLI Flags

If you are using the example CLI provided in cmd/updater, the following flags are available:

  • --check-update: Check for new updates without applying them.
  • --do-update: Perform an update if available.
  • --channel: Set the update channel (e.g., stable, beta, alpha). If not set, it's determined from the current version tag.
  • --force-semver-prefix: Force 'v' prefix on semver tags (default true).
  • --release-url-format: A URL format for release assets.
  • --pull-request: Update to a specific pull request (integer ID).