Configure cookietemple

To prevent frequent prompts for information, which rarely or never changes at all such as the full name, email or Github username of the user, cookietemple uses a configuration file. Moreover, the personal access token associated with the Github username is stored, in encrypted form, to allow for various Github functionalities, such as automatic Github repository creation or Syncing your project. The creation of projects with cookietemple requires a configuration file. A personal access token is not required, if Github support is not used. The configuration file is saved operating system dependent in common config file locations (~/.config/cookietemple on Unix, C:\Users\Username\AppData\Local\cookietemple\cookietemple on Windows). Configuring cookietemple is only required once, although it is always possible to update the current configuration.

Usage

Invoke cookietemple config via

$ cookietemple config <all/general/pat>
  • all : Prompt for the full name, email, Github username and Github personal access token.

  • general : Only prompt for the full name, email and the Github username.

    These details are required to create projects.

  • pat : Solely prompts for the Github personal access token and updates it if already set.

    Ensure that your Github username still matches with the new personal access token. If not you should also update your Github username via cookietemple config general. Additionally, any of your already created projects may still feature your old token and you may therefore run into issues when attempting to push. Hence, you must also update your remote URL for those projects!

Flags

  • --view : To get your current cookietemple configuration.

    The explicit value of your Github personal access token will not be printed. You will only be informed about whether it is set or not.

On Github personal access tokens

cookietemple’s Github support requires access to your Github repositories to create repositories, add issues labels and set branch protection rules. Github manages these access rights through Personal Access Tokens (PAT). If you are using cookietemple’s Github support for the first time cookietemple config pat will be run and you will be prompted for your Github PAT. Please refer to the official documentation on how to create one. cookietemple requires repo access and workflow. This ensures that your PAT would not even allow for the deletion of repositories. cookietemple then encrypts the Personal Access Token, adds the encrypted token to the cookietemple_conf.cfg file and saves the key locally in a hidden place. This is safer than Github’s official way, which recommends the usage of environment variables or Github Credentials, which both save the token in plaintext. It is still strongly advised to secure your personal computer and not allow any foe to get access.