Skip to content

Commit

Permalink
docs: update examples with bubbletea
Browse files Browse the repository at this point in the history
  • Loading branch information
Madh93 committed May 19, 2023
1 parent 92b1f3b commit b1b4c7d
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 8 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Use "tpm [command] --help" for more information about a command.

### Install a provider

To install a provider you only need to provide the name. Optionally, you can specify a version by using `<package>@<version>`. By default, if no version is specified, the latest avaiable version, also known as `@latest`, will be installed.
To install a provider you only need to provide the name. Optionally, you can specify a version by using `<package>@<version>`. By default, if no version is specified, the latest available version, also known as `@latest`, will be installed.

You can also specify the architecture and operating system. If not specified, the information from the system where tpm is being executed will be used.

Expand All @@ -93,6 +93,13 @@ In addition, it's possible to install multiple providers at once specifying a `p
```yaml
providers:
- name: hashicorp/aws@3.64.0
- name: hashicorp/http@3.3.0
os:
- linux
- darwin
arch:
- amd64
- arm64
- name: hashicorp/random
os:
- linux
Expand All @@ -104,6 +111,8 @@ providers:
<img alt="Install providers from file" src="docs/gif/install-from-file.gif"/>
The providers are installed in parallel by default. You can adjust the number of parallel jobs by using the `--jobs <NUMBER>` flag.

### List installed providers

This will display on the screen the installed providers. Optionally, you can specify an output format. Valid output formats are:
Expand Down
Binary file modified docs/gif/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 9 additions & 3 deletions docs/gif/demo.tape
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
Output demo.gif

Set FontSize 24
Set FontSize 26
Set Width 1200
Set Height 400
Set Height 350

Type "tpm install hashicorp/http@3.2.1"
Type "tpm install hashicorp/aws@4.67.0"
Sleep 500ms
Enter
Sleep 5s

Ctrl+L
Type "tpm install --from-file providers.yml"
Sleep 500ms
Enter
Sleep 4s
Expand Down
Binary file modified docs/gif/install-from-file.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/gif/install-from-file.tape
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Output install-from-file.gif

Set FontSize 20
Set Width 1200
Set Height 600
Set Height 400

Type "tpm install --from-file examples/01-basic.yml"
Sleep 500ms
Expand Down
Binary file modified docs/gif/install.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/gif/install.tape
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ Output install.gif

Set FontSize 20
Set Width 1200
Set Height 600
Set Height 350

Type "tpm install hashicorp/aws"
Sleep 500ms
Enter
Sleep 8s
Sleep 5s

Ctrl+L
Type "tpm install hashicorp/aws@latest"
Expand Down
Binary file modified docs/gif/uninstall.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/gif/uninstall.tape
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Output uninstall.gif

Set FontSize 20
Set Width 1200
Set Height 600
Set Height 300

Type "tpm uninstall hashicorp/aws"
Sleep 500ms
Expand Down
7 changes: 7 additions & 0 deletions examples/02-multi-os-arch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ providers:
- windows
arch:
- amd64
- name: hashicorp/http@3.3.0
os:
- linux
- darwin
arch:
- amd64
- arm64
- name: hashicorp/random
os:
- linux
Expand Down

0 comments on commit b1b4c7d

Please sign in to comment.