Improve SSH config instructions

README.md

@@ -8,12 +8,12 @@ A modern [Cookiecutter](https://cookiecutter.readthedocs.io) template for scaffo
 <summary>Setting up a new project with this template</summary>
 
 1. Install [Cruft](https://cruft.github.io/cruft/) in your Python environment with:
-   ```bash
+   ```sh
    pip install cruft
    ```
 2. Create a new repository and clone it locally.
 3. In the repository's parent directory, run:
-   ```bash
+   ```sh
    cruft create -f git@github.com:radix-ai/poetry-cookiecutter.git
    ```
 

{{ cookiecutter.package_name|slugify }}/README.md

@@ -18,10 +18,19 @@ To add and install this package as a dependency of your project, run `poetry add
 <summary>Setup: once per device</summary>
 
 {% if cookiecutter.continuous_integration == "GitLab" -%}
-1. [Generate an SSH key](https://docs.gitlab.com/ee/ssh/README.html#generate-an-ssh-key-pair) for GitLab, [add the SSH key to your GitLab account](https://docs.gitlab.com/ee/ssh/README.html#add-an-ssh-key-to-your-gitlab-account), and [add the SSH key to your authentication agent](https://docs.gitlab.com/ee/ssh/README.html#configure-ssh-to-point-to-a-different-directory).
+1. [Generate an SSH key](https://docs.gitlab.com/ee/ssh/README.html#generate-an-ssh-key-pair) and [add the SSH key to your GitLab account](https://docs.gitlab.com/ee/ssh/README.html#add-an-ssh-key-to-your-gitlab-account).
+1. Configure SSH to automatically load your SSH keys:
+    ```sh
+    cat << EOF >> ~/.ssh/config
+    Host *
+      AddKeysToAgent yes
+      IgnoreUnknown UseKeychain
+      UseKeychain yes
+    EOF
+    ```
 {%- if cookiecutter.private_package_repository_name %}
 1. [Create a personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) with the `api` scope and use it to [configure Poetry's credentials for this package's private repository](https://python-poetry.org/docs/repositories/#configuring-credentials):
-    ```bash
+    ```sh
     # bash
     echo "export POETRY_HTTP_BASIC_{{ cookiecutter.private_package_repository_name|upper }}_USERNAME='{personal access token name}'" >> ~/.bash_profile
     echo "export POETRY_HTTP_BASIC_{{ cookiecutter.private_package_repository_name|upper }}_PASSWORD='{personal access token}'" >> ~/.bash_profile
@@ -36,10 +45,19 @@ To add and install this package as a dependency of your project, run `poetry add
     ```
 {%- endif %}
 {%- else -%}
-1. [Generate an SSH key and add it to your authentication agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent), and [add the SSH key to your GitHub account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).
+1. [Generate an SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key) and [add the SSH key to your GitHub account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).
+1. Configure SSH to automatically load your SSH keys:
+    ```sh
+    cat << EOF >> ~/.ssh/config
+    Host *
+      AddKeysToAgent yes
+      IgnoreUnknown UseKeychain
+      UseKeychain yes
+    EOF
+    ```
 {%- if cookiecutter.private_package_repository_name %}
 1. [Configure Poetry's credentials for this package's private repository](https://python-poetry.org/docs/repositories/#configuring-credentials):
-    ```bash
+    ```sh
     # bash
     echo "export POETRY_HTTP_BASIC_{{ cookiecutter.private_package_repository_name|upper }}_USERNAME='{username}'" >> ~/.bash_profile
     echo "export POETRY_HTTP_BASIC_{{ cookiecutter.private_package_repository_name|upper }}_PASSWORD='{password}'" >> ~/.bash_profile
@@ -56,7 +74,7 @@ To add and install this package as a dependency of your project, run `poetry add
 {%- endif %}
 1. [Install Docker Desktop](https://www.docker.com/get-started).
 1. [Configure Docker and Docker Compose to use the BuildKit build system](https://pythonspeed.com/articles/docker-buildkit/):
-    ```bash
+    ```sh
     # bash
     echo "export DOCKER_BUILDKIT=1" >> ~/.bash_profile
     echo "export COMPOSE_DOCKER_CLI_BUILD=1" >> ~/.bash_profile