@savaryna/git-add-account 2.0.0 → 2.0.1

package/README.md

@@ -1,81 +1,88 @@
 # @savaryna/add-git-account
 
-🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine. It switches between accounts automatically based on the workspace (directory) you are in.
+🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine. It switches between accounts automatically based on the workspace _(directory/subdirectory)_ you are in.
 
 ## Usage
 
-Run the command direcly:
+Run the command direcly with
+
 ```shell
 npx @savaryna/git-add-account
 ```
 
-or if you want to install it globally:
+or if you want, first install it globally
 
 ```shell
 npm i -g @savaryna/git-add-account
+```
 
-# now you can run it by invoking
-git-add-account
+then you can run it using
 
-# or
-gaa
+```shell
+git-add-account
 ```
 
-After going through all the steps:
+or
 
 ```shell
-✔ Name to use for this account: … Example Name
-✔ Email to use for this account: … example@email.com
-✔ Workspace to use for this account: … /Users/savaryna/code/email
-✔ Name to use for SSH keys: … email_example_name
-Enter passphrase (empty for no passphrase):
-Enter same passphrase again:
-✔ Do you want to sign your work? … no / yes
-
-Your public SSH key is:  ssh-ed25519 AAAAC3NlZ...DITJheGo example@email.com
-You can also find it here:  /Users/savaryna/.ssh/git_email_example_name.pub
-Add it to your favorite GIT provider and enjoy!
-
-✨ Done. Thanks for using @savaryna/git-add-account!
+gaa
 ```
 
-You will be presented with your public SSH key so you can copy, and add it to your GIT provider. For example GitHub[^1]:
+After going through all the steps, you will be presented with your public SSH key so you can copy, and add it to your GIT provider. For example GitHub[^1]:
 
 1. Go to your account [settings / keys](https://github.com/settings/keys)
-2. Click on `New SSH key`
-3. Give it any title
-4. Choose `Authentication Key` for key type
-4. Paste in the public SSH key copied earlier in the key field
-5. Repeat steps 2 - 4 to add a `Signing Key` key type, if you chose to sign your work (Commits, Tags, Pushes)[^2]
-6. Done! Now you can go to the workspace you chose for the account `/Users/savaryna/code/email` in this example, and all the GIT
-commands issued from this and children directories will automatically use the correct account.
-
-## How it works
-
-A simple way to use multiple git accounts on one machine is to use multiple SSH keys configured with different hosts. The way [@savaryna/add-git-account](https://www.npmjs.com/package/@savaryna/git-add-account) works is, it asks you for some basic information and then:
-
-1. It creates a `.gitconfig` file in the workspace directory you specified.
-2. It creates a SSH keypair using `ssh-keygen -t ed25519 -C "email@you.specified" -f ~/.ssh/git_the_ssh_key_name_you_specified`.
-3. It appends to the `~/.ssh/config` file.
-    ```ini
-    # Config for GIT account email@you.specified
-    Host *
-      AddKeysToAgent yes
-      UseKeychain yes
-      IdentityFile path/to/the/SSH/key/created/in/step/2
-    ```
-4. It runs `git config --file path/to/.gitconfig/from/step/1 user.name "name_you_specified"` to set your git username.
-5. It runs `git config --file path/to/.gitconfig/from/step/1 user.email "email@you.specified"` to set your git email.
-6. It runs `git config --file path/to/.gitconfig/from/step/1 core.sshCommand "ssh -i path/to/the/SSH/key/created/in/step/2"` to make sure all the commands issued from this workspace use the correct SSH key.
-7. If you chose to sign your work:
-    1. It runs `git config --file path/to/.gitconfig/from/step/1 gpg.format ssh` to use SSH key for signing.
-    2. It runs `git config --file path/to/.gitconfig/from/step/1 commit.gpgsign true` to enable signing commits.
-    3. It runs `git config --file path/to/.gitconfig/from/step/1 push.gpgsign if-asked` to enable signing pushes if supported.
-    4. It runs `git config --file path/to/.gitconfig/from/step/1 tag.gpgsign true` to enable signing tags.
-    5. It runs `git config --file path/to/.gitconfig/from/step/1 user.signingkey path/to/the/SSH/key/created/in/step/2` to set the signing key to the one created in step 2.
-8. It runs `git config --global includeIf.gitdir:path/to/your/workspace/.path $path/to/.gitconfig/from/step/1`, this makes sure that if you are in the workspace for the created account, git will use the config from step 1 with all the options from the step 5, 6 and 7 automatically.
-9. And finally it presents you with your public SSH key so you can copy it and add it to your GIT provider of choice.
-
+1. Click on `New SSH key`
+1. Give it a title
+1. Choose `Authentication Key` for key type
+1. Paste in the public SSH key copied earlier in the key field
+1. Click on `Add SSH key`
+1. Repeat steps **2 through 6** to add a `Signing Key` key type, if you chose to sign your work (Commits, Tags, Pushes)[^2]
+1. Done! Now, you can go to the workspace you chose for the account, ex: `cd /Users/john/code/work`, and all the `git`
+   commands issued from this, **or any other subdirectory**, will automatically use the correct account/ssh keys.
+
+## Example of how it works
+
+A simple way to use multiple git accounts on one machine is to use different SSH configs based on the directory you are in. The way [@savaryna/add-git-account](https://www.npmjs.com/package/@savaryna/git-add-account) works is, it asks you for some basic information and then it creates some files under `.config` in the workspace directory you specified. Ex:
+
+1. It creates a _(private/public)_ SSH keypair using `ssh-keygen -t ed25519 -C "john@github.com" -f /Users/john/code/work/.config/id_ed25519_git_github_com`. [See code](https://github.com/savaryna/git-add-account/blob/main/index.js#L24-L25).
+1. It creates a `sshconfig` file. [See code](https://github.com/savaryna/git-add-account/blob/main/index.js#L35-L47).
+
+   ```ini
+   # File at /Users/john/code/work/.config/sshconfig
+   # Config for GIT account john@github.com
+   Host github.com
+     HostName github.com
+     User git
+     AddKeysToAgent yes
+     UseKeychain yes
+     IdentitiesOnly yes
+     IdentityFile /Users/john/code/work/.config/id_ed25519_git_github_com
+   ```
+
+1. It creates a `gitconfig` file. [See code](https://github.com/savaryna/git-add-account/blob/main/index.js#L49-L75).
+
+   ```ini
+   # File at /Users/john/code/work/.config/gitconfig
+   # Config for GIT account john@github.com
+   [user]
+     name = John Doe
+     email = john@github.com
+   [core]
+     sshCommand = ssh -F /Users/john/code/work/.config/sshconfig
+   [gpg]
+     format = ssh
+   [commit]
+     gpgsign = true
+   [push]
+     gpgsign = if-asked
+   [tag]
+     gpgsign = true
+   [user]
+     signingkey = /Users/john/code/work/.config/id_ed25519_git_github_com
+   ```
+
+1. It runs `git config --global includeIf.gitdir:/Users/john/code/work/.path /Users/john/code/work/.config/gitconfig`, this makes sure that as long as you are in the workspace created earlier, **or any other subdirectory**, git will use the config from step **3** automatically[^3]. [See code](https://github.com/savaryna/git-add-account/blob/main/index.js#L77-L78).
+1. And finally, it presents you with your public SSH key so you can copy it and add it to your GIT provider of choice.
 
 ## License
 
@@ -83,3 +90,4 @@ A simple way to use multiple git accounts on one machine is to use multiple SSH
 
 [^1]: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account?tool=webui
 [^2]: https://docs.github.com/en/authentication/managing-commit-signature-verification
+[^3]: https://git-scm.com/docs/git-config#_conditional_includes

package/index.js

@@ -48,6 +48,7 @@ async function main() {
 
   // Create gitconfig for the workspace
   const gitConfig = `
+    # Config for GIT account ${email}
     [user]
       name = ${name.value}
       email = ${email}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@savaryna/git-add-account",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "🔐 A small CLI app that allows you to easily add multiple GIT accounts on one machine. It switches between accounts automatically based on the workspace (directory) you are in.",
   "homepage": "https://github.com/savaryna/git-add-account#readme",
   "keywords": [