# astu

> A tool for generating AWS security tokens

Latest version **0.0.5** (published 2019-01-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install astu
pnpm add astu
yarn add astu
bun add astu
```

Provides the command `astu`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2019-01-19 |
| First published | 2019-01-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 57.4 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Peter Borgstedt |
| Maintainers | peter-borgstedt |

## Links

- npm: https://www.npmjs.com/package/astu
- Repository: https://github.com/peter-borgstedt/astu
- Homepage: https://github.com/peter-borgstedt/astu#readme
- Issues: https://github.com/peter-borgstedt/astu/issues
- npm.io page: https://npm.io/package/astu

## Dependencies (6)

- [fmt](https://npm.io/package/fmt.md) 1.1.0
- [ora](https://npm.io/package/ora.md) 3.0.0
- [chalk](https://npm.io/package/chalk.md) 2.4.1
- [aws-sdk](https://npm.io/package/aws-sdk.md) 2.373.0
- [inquirer](https://npm.io/package/inquirer.md) 6.2.1
- [commander](https://npm.io/package/commander.md) 2.19.0

## Recent versions

- 0.0.5 (latest) — 2019-01-19
- 0.0.4 — 2019-01-19
- 0.0.3 — 2019-01-19
- 0.0.2 — 2019-01-19

## README

# ASTU a.k.a. AWS security token utility
A tool to help developers easily work with temporary security tokens between different accounts in AWS.

## Prerequisites
All **master credential profiles** are profiles in the *".aws/credentials"* -file that have the right to change role in one or several AWS accounts. Basically it uses AWS STS to generate a temporary token.

These profiles needs to be defined in *".aws/credentials"* -file. If there are MFA then the serial must be included.

```
[a_master_credential]
aws_access_key_id = <access-key>
aws_secret_access_key = <secret-access-key>
mfa_serial = arn:aws:iam::<account-id>:mfa/<iam-user-name>
```

```
[a_role_in_an_account]
region = eu-west-1
role_arn = arn:aws:iam::<account-id>:role/<role>
source_profile = a_master_credential-temp
output = json
```

The *-temp profile is the temporary token that has been generated.

## Installation
It is preferable to install it globally if there are many projects using it, but otherwise it can be installed within a project. However, note that the configuration is stored in the user home directory, so if there are several instances of it, they will all use the same configuration file.
```bash
> npm install -g astu
```

## Usage
The command syntax is using the following pattern:
```bash
> astu [options] [commands]
```

### Options
> **--version ( or: -V )**
> *Output the version number*
> ```bash
> > astu --version
>```

> **--verbose ( or: -v )**
> *Add this to any command to see more details *
> ```bash
> > astu --version
>```

> **--help ( or: -h )**
> *Output usage information*
> ```bash
> > astu --version
>```

### Commands
> ***(*** *""* ***)***
> If no arguments are entered  the usage information will displayed (see options -h, --help)*
> ```bash
> > astu
>```

> ***( \<profile\> )***
> *Generate a temporary token for a **specific** given master credential profile*
> ```bash
> > astu <profile>
>```

> **generate ***( or: g )*****
> *Generate temporary token for **all configured** master credential profiles (see **config**)*
> ```bash
> > astu [options] g|generate
>```

> **information ***( or: i )*****
> *Details of current environment and settings*
> ```bash
> > astu [options] i|information
>```

> **config ***( or: c )*****
> *Select default profile and master credentials*
> ```bash
> > astu [options] c|config
>```

> **update ***( or: u )*****
> *The tool will indicate when running if any update is available, if so, this command will update to latest version.*
> ```bash
> > astu [options] u|update
>```

---
_Source: https://npm.io/package/astu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._