Skip to content

Commit

Permalink
fix(ci): Fix workflow names
Browse files Browse the repository at this point in the history
  • Loading branch information
pbar1 committed Nov 8, 2024
1 parent 86214dd commit 63d5189
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 9 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/go.yml → .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
# This workflow will build a golang project
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go

name: Go
name: build

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: goreleaser
name: release

on:
pull_request:
Expand Down
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<h3 align="center">AWS Multi-Factor Authentication manager</h3>

<p align="center">
<a href="https://travis-ci.org/pbar1/mfaws">
<img alt="Build Status" src="https://travis-ci.org/pbar1/mfaws.svg?branch=develop">
<a href="https://github.com/pbar1/mfaws/actions/workflows/go.yml">
<img alt="Build Status" src="https://github.com/pbar1/mfaws/actions/workflows/go.yml/badge.svg">
</a>
<a href="https://github.com/pbar1/mfaws/releases/latest">
<img alt="GitHub release" src="https://img.shields.io/github/release/pbar1/mfaws.svg">
Expand All @@ -21,21 +21,27 @@
</p>

<!-- installation -->

## Installation

#### Install script (Linux & macOS)

Download the appropriate binary from the releases page, `chmod +x`, and drop it into your `PATH`.

#### [Chocolatey][4] (Windows)

```powershell
choco install mfaws
```

**Note**: Make sure your hardware clock is correct! [Especially if dual booting][7]. If your time is out of sync, your MFA attempts will fail _and_ the codes `oathtool` generates will be wrong (if you use it).

<!-- installationstop -->

<!-- usage -->

## Usage

```
AWS Multi-Factor Authentication manager
Expand Down Expand Up @@ -64,13 +70,17 @@ Flags:
Use "mfaws [command] --help" for more information about a command.
```

<!-- usagestop -->

<!-- examples -->

## Examples

#### Using the default profile

Make sure you have the following in your `$HOME/.aws/credentials` file:

```
[default-long-term]
aws_access_key_id = $YOUR_AWS_ACCESS_KEY_ID
Expand All @@ -79,22 +89,26 @@ aws_mfa_device = $YOUR_MFA_DEVICE_ARN
```

Then, simply run

```sh
mfaws
```

to fetch temporary credentials for your **default** AWS profile. More advanced configuration is possible (see [Usage](#usage)).

#### Combine `mfaws` with [`oathtool`][2]

Set an alias for generating your MFA token, then pipe it into `mfaws`:

```sh
alias otp-aws="oathtool --totp --base32 $YOUR_AWS_TOTP_KEY"

otp-aws | mfaws
# or
otp-aws | mfaws -p some-profile
```
<!-- examplesstop -->

<!-- examplesstop -->

[1]: https://github.com/pbar1/mfaws/releases
[2]: https://www.nongnu.org/oath-toolkit/
Expand Down

0 comments on commit 63d5189

Please sign in to comment.