Skip to content

Commit

Permalink
Added instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix Breidenstein committed Feb 24, 2020
1 parent fb5d045 commit 401959f
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 3 deletions.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
d5td xsru qasx caxs m5q5 pv76 keui v7hr
# shared-2fa

This tool helps you to share a virtual TOTP MFA-device with a team by saving the intial seed at AWS SecretsManager.

```
Available Commands:
add Create a new entry
delete Delete an entry
generate Generate a token for the given entry
help Help about any command
list A brief description of your command
```

## add
```
Create a new entry
Usage:
shared-2fa add <name> <seed>
```

## delete
```
Delete an entry
Usage:
shared-2fa delete <name>
```

## generate
```
Generate a token for the given entry
Usage:
shared-2fa generate <name>
```

## list
```
List all available entries
Usage:
shared-2fa list
```
2 changes: 1 addition & 1 deletion cmd/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (

var listCmd = &cobra.Command{
Use: "list",
Short: "A brief description of your command",
Short: "List all available entries",
Run: func(cmd *cobra.Command, args []string) {
svc := secretsmanager.New(session.New(&aws.Config{
Region: aws.String(config.AWS_REGION),
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ var cfgFile string
// rootCmd represents the base command when called without any subcommands
var rootCmd = &cobra.Command{
Use: "shared-2fa",
Short: "A brief description of your application",
Short: "Tool to save TOTP seed in AWS SecretsManager and use for token generation",
}

// Execute adds all child commands to the root command and sets flags appropriately.
Expand Down

0 comments on commit 401959f

Please sign in to comment.