Skip to content

Commit

Permalink
AWS pager blog (#75)
Browse files Browse the repository at this point in the history
* AWS pager blog

* use vhs instead of asciinema
  • Loading branch information
rmoff authored Apr 26, 2024
1 parent fbe45ac commit 1fffb2e
Show file tree
Hide file tree
Showing 11 changed files with 165 additions and 0 deletions.
21 changes: 21 additions & 0 deletions content/code/aws-pager/0.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Where should we write the GIF?
Output ../../../static/images/2024/04/help0.mp4

# Set up a 1200x600 terminal with 46px font.
Set Padding 10
Set FontSize 15
Set Width 800
Set Height 500
Set Shell zsh
Set WindowBar Colorful

# Type a command in the terminal.
Type "aws iam create-role help"
Sleep 500ms
Enter

Sleep 2s
Type "q"

# Admire the output for a bit.
Sleep 1s
25 changes: 25 additions & 0 deletions content/code/aws-pager/1.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Where should we write the GIF?
Output ../../../static/images/2024/04/help1.mp4

# Set up a 1200x600 terminal with 46px font.
Set Padding 10
Set FontSize 15
Set Width 800
Set Height 500
Set Shell zsh
Set WindowBar Colorful

# Type a command in the terminal.
Type `export MANPAGER='less -isXF'`
Sleep 1s
Enter

Type "aws iam create-role help"
Sleep 500ms
Enter

Sleep 2s
Type "q"

# Admire the output for a bit.
Sleep 1s
27 changes: 27 additions & 0 deletions content/code/aws-pager/2.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Where should we write the GIF?
Output ../../../static/images/2024/04/help2.mp4

# Set up a 1200x600 terminal with 46px font.
Set Padding 10
Set FontSize 15
Set Width 800
Set Height 500
Set Shell zsh
Set WindowBar Colorful

Hide
Type "export AWS_PAGER=less && clear"
Enter
Show

# Type a command in the terminal.
Type "aws iam list-role-policies --role-name rmoff-decodable-s3"
Sleep 500ms
Enter

Sleep 2s
Type "q"


# Admire the output for a bit.
Sleep 1s
31 changes: 31 additions & 0 deletions content/code/aws-pager/3.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Where should we write the GIF?
Output ../../../static/images/2024/04/help3.mp4

# Set up a 1200x600 terminal with 46px font.
Set Padding 10
Set FontSize 15
Set Width 800
Set Height 500
Set Shell zsh
Set WindowBar Colorful

# Type a command in the terminal.
Type "aws iam list-role-policies --role-name rmoff-decodable-s3 --no-cli-pager"
Sleep 500ms
Enter

Sleep 3s

Type `clear`
Enter
Type `export AWS_PAGER='less -isXF'`
Sleep 1s
Enter

Type "aws iam list-role-policies --role-name rmoff-decodable-s3
Sleep 500ms
Enter


# Admire the output for a bit.
Sleep 1s
61 changes: 61 additions & 0 deletions content/post/aws-pager.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
draft: false
title: 'How to stop AWS CLI clearing the screen'
date: "2024-04-26T12:49:50Z"
image: "/images/2024/04/h_IMG_1253.webp"
thumbnail: "/images/2024/04/t_IMG_1105.webp"
credit: "https://twitter.com/rmoff/"
categories:
- aws
- pager
---

:source-highlighter: rouge
:icons: font
:rouge-css: style
:rouge-style: github

After a break from using AWS I had reason to reacquaint myself with it again today, and did so via the CLI. The https://aws.amazon.com/cli/[AWS CLI] is pretty intuitive and has a good helptext system, but one thing that kept frustrasting me was that after closing the help text, the screen cleared—so I couldn't copy the syntax out to use in my command!

The same thing happened when I ran a command that returned output - the screen cleared.

Here's how to fix either, or both, of these

<!--more-->

== AWS CLI help text disappears when closed

video::/images/2024/04/help0.mp4[]

The fix: set `MANPAGER` (https://ashley.raiteri.net/stop-aws-cli-help-command-from-clearing-screen/[h/t])

[source,bash]
----
export MANPAGER='less -isXF'
----

video::/images/2024/04/help1.mp4[]

== AWS CLI command output disappears when closed

Similar to the above, but a different solution, which confuses the issue when Googling :)

You run a command, you want to refer to the output, but as soon as you return to the command prompt it's gone 🤨

video::/images/2024/04/help2.mp4[]

The fix: make sure that `AWS_PAGER` is set to the correct invocation of `less`. Or other options, including setting `--no-cli-pager` argument. This https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-pagination.html#cli-usage-pagination-clientside[is documented] if you want to read more.

[source,bash]
----
export AWS_PAGER='less -isXF'
----

or simply

[source,bash]
----
unset AWS_PAGER
----

video::/images/2024/04/help3.mp4[]
Binary file added static/images/2024/04/h_IMG_1253.webp
Binary file not shown.
Binary file added static/images/2024/04/help0.mp4
Binary file not shown.
Binary file added static/images/2024/04/help1.mp4
Binary file not shown.
Binary file added static/images/2024/04/help2.mp4
Binary file not shown.
Binary file added static/images/2024/04/help3.mp4
Binary file not shown.
Binary file added static/images/2024/04/t_IMG_1105.webp
Binary file not shown.

0 comments on commit 1fffb2e

Please sign in to comment.