aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bba273d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Github SSH Key
+--------------
+
+Sync local user's SSH AuthorizedKey with ones from their Github Account.
+
+```
+Usage: github-ssh-key <flags> <subcommand> <subcommand args>
+
+Subcommands:
+ commands list all command names
+ fetch fetch SSH keys for the given Github Users
+ flags describe all known top-level flags
+ help describe subcommands and their syntax
+ sync-group Sync SSH keys for the given groups.
+ sync-users Sync SSH keys for the given users.
+
+
+Use "github-ssh-key flags" for a list of top-level flags
+```
+
+The tool expects a user's Github account to be defined in the '.github-id' file in their home directory.
+
+### Related or Similar Projects
+
+ - [ssh-keys-from-remotes](https://github.com/liamdawson/ssh-keys-from-remotes)
+ - [Monkeysphere](https://web.monkeysphere.info)