cloudhop 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,13 +1,20 @@
1
1
  # cloudhop
2
2
 
3
- > 🚧 Early preview. The CLI is under active development.
3
+ [![Pipeline](https://github.com/dayepesb/cloudhop/actions/workflows/pipeline.yml/badge.svg)](https://github.com/dayepesb/cloudhop/actions/workflows/pipeline.yml)
4
+ [![npm](https://img.shields.io/npm/v/cloudhop)](https://www.npmjs.com/package/cloudhop)
5
+
6
+ > 🚧 Early preview. AWS works today; Azure and Google Cloud are planned.
4
7
 
5
8
  Hop between cloud accounts, roles and regions with one command.
6
9
 
7
10
  ```bash
8
11
  npm i -g cloudhop
12
+ cloudhop setup # pick your clouds, add an SSO portal or personal account
9
13
 
10
14
  hop pragma1 s3 ls # runs `aws s3 ls` with the right account, role and region
15
+ hop pragma1 # who am I?
16
+ cloudhop exec pragma1 -- terraform plan
17
+ cloudhop ui # or manage everything from a local web page
11
18
  ```
12
19
 
13
20
  ## Why
@@ -16,12 +23,38 @@ Working with several AWS SSO portals plus personal accounts means copying
16
23
  access keys, editing `~/.aws/config` by hand and logging in again and again.
17
24
  cloudhop is a thin proxy over the AWS CLI that:
18
25
 
19
- - Adds SSO portals and personal accounts interactively (CLI or local web UI).
26
+ - Adds SSO portals and personal accounts interactively.
20
27
  - Discovers every account and role you have access to and creates aliases.
21
- - Logs you in automatically, only when a session has expired.
22
- - Never stores long-lived secrets: it uses AWS SSO and `aws login` temporary credentials.
28
+ - Logs you in automatically, only when a session has expired, and refreshes
29
+ every account of that portal at the same time.
30
+ - Never stores long-lived secrets: it uses AWS IAM Identity Center and
31
+ `aws login` temporary credentials.
32
+ - Writes standard profiles to `~/.aws/config`, so Terraform, SDKs and IDEs
33
+ see the same aliases.
34
+
35
+ ## Documentation
36
+
37
+ https://dayepesb.github.io/cloudhop (English and Spanish).
38
+
39
+ ## Contributing
40
+
41
+ ```bash
42
+ pnpm install
43
+ pnpm test # unit tests
44
+ pnpm build && pnpm test:e2e # CLI end-to-end tests (sandboxed)
45
+ pnpm exec playwright install chromium && pnpm test:web # web UI tests
46
+ pnpm audit # dependency vulnerabilities
47
+ pnpm typecheck
48
+ pnpm lint
49
+ pnpm build # bundles packages/cli/dist/cli.js
50
+ node packages/cli/dist/cli.js --help
51
+ pnpm docs:dev # documentation site
52
+ ```
23
53
 
24
- Support for other clouds (Azure, Google Cloud) is planned.
54
+ Read [ARCHITECTURE.md](ARCHITECTURE.md) before changing the code; it also
55
+ explains the pipeline and how releases are approved. Use
56
+ `CLOUDHOP_HOME` and `CLOUDHOP_AWS_DIR` to try things without touching your
57
+ real configuration.
25
58
 
26
59
  ## License
27
60