Reset#

The reset command restores specific configurations in Patcher, allowing users to reset credentials, UI settings, or cached data. By default, a full reset clears all configurations and triggers the setup process. Users can reset individual components without affecting other settings.

Parameters#

kind(str)REQUIRED

Specifies the type of reset to perform:

Option

Description

full

Resets credentials, UI elements, and property list file. Subsequently triggers Setup to start setup

UI

Resets UI elements of PDF reports (header & footer text, custom font and optional logo)

creds

Resets credentials stored in Keychain. Useful for testing Patcher in a non-production environment first. Allows specifying which credential to reset using the --credential option

cache

Removes all cached data from the cache directory stored in ~/Library/Caches/Patcher

Note

Options are not case-sensitive and are converted to lowercase automatically at runtime

credential(Optional[str])

The specific credential to reset when performing credentials reset. Defaults to all credentials if none specified.

Usage#

Important

Performing a full credential reset will prompt for all client credentials (URL, Client ID, Client Secret). Do not use this method unless you are confident you have access to these credentials, especially if:

  • Your environment does not use SSO.

  • You relied on the automatic setup of Patcher (STANDARD)

Note

You can reset individual credentials by specifying one of the following options:

  • url

  • client_id

  • client_secret

$ patcherctl reset full

This will reset all configurations (credentials, UI elements, and property list file) and initiate the setup process.

$ patcherctl reset UI

This is useful if you only need to refresh the appearance of generated reports (header/footer text or custom logos).

$ patcherctl reset creds

This will prompt you to provide new values for URL, Client ID, and Client Secret.

$ patcherctl reset creds --credential url

You will be prompted to enter a new value for the credential specified to be reset.

$ patcherctl reset cache

Removes all cache files from cache directory. See data caching for more.