Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
462 changes: 87 additions & 375 deletions README.md

Large diffs are not rendered by default.

57 changes: 57 additions & 0 deletions assets/gifs/.gif-create.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# .gif-create.yml
# Itential brand configuration for terminal GIF recordings
# Colors sourced from Itential Brand Guidelines (January 2022)

brand:
# Custom colors derived from Itential brand palette
colors:
background: "#101625" # Navy (primary brand color)
foreground: "#FFFFFF" # White (body text on dark backgrounds)
cursor: "#FFFFFF" # White (matches foreground)
cursorAccent: "#101625" # Navy (text inside cursor block)
border: "#1B93D2" # Bright Blue (primary accent)
selection: "#1B93D2" # Bright Blue (selection highlight)
# ANSI colors mapped to Itential brand palette
black: "#101625" # Navy
red: "#FF6633" # Orange (secondary palette)
green: "#99CA3C" # Green (secondary palette)
yellow: "#FFAC73" # Light Orange (extended palette)
blue: "#1B93D2" # Bright Blue (primary palette)
magenta: "#C5258F" # Pink (secondary palette)
cyan: "#E5F2FE" # Light Blue (secondary palette)
white: "#FFFFFF" # White
brightBlack: "#414042" # 90% Grey (text color)
brightRed: "#FF6633" # Orange
brightGreen: "#99CA3C" # Green
brightYellow: "#FFAC73" # Light Orange
brightBlue: "#1B93D2" # Bright Blue
brightMagenta: "#C5258F" # Pink
brightCyan: "#E5F2FE" # Light Blue
brightWhite: "#FFFFFF" # White

# Typography
font_family: "MonoLisa, Menlo, monospace"
font_size: 14
line_height: 1.4
letter_spacing: 0
padding: 20

# Terminal chrome
border_radius: 8
margin: 4
margin_fill: "#0D1018"
window_bar: "Colorful"

# Prompt styling
prompt: "bold"
prompt_color: "#C5258F" # Pink (secondary palette)

# Default output settings
defaults:
preset: "github-readme"
typing_speed: "50ms"

# Directory conventions
paths:
tapes: "assets/gifs/tapes"
output: "assets/gifs"
Binary file added assets/gifs/ipctl-output-formats.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/ipctl-version.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gifs/ipctl-workflow.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions assets/gifs/tapes/ipctl-output-formats.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Generated by gif-create
Output assets/gifs/ipctl-output-formats.gif

# Terminal
Set Shell "bash"
Set Width 900
Set Height 600
Set FontSize 14
Set FontFamily "MonoLisa, Menlo, monospace"
Set LineHeight 1.4
Set LetterSpacing 0
Set Padding 20

# Brand (Itential)
Set Theme {"name":"Itential","black":"#101625","red":"#FF6633","green":"#99CA3C","yellow":"#FFAC73","blue":"#1B93D2","purple":"#C5258F","cyan":"#E5F2FE","white":"#FFFFFF","brightBlack":"#414042","brightRed":"#FF6633","brightGreen":"#99CA3C","brightYellow":"#FFAC73","brightBlue":"#1B93D2","brightPurple":"#C5258F","brightCyan":"#E5F2FE","brightWhite":"#FFFFFF","background":"#101625","foreground":"#FFFFFF","selectionBackground":"#1B93D2","cursor":"#FFFFFF","cursorAccent":"#101625"}
Set BorderRadius 8
Set MarginFill "#0D1018"
Set Margin 4
Set WindowBar "Colorful"

# Timing
Set TypingSpeed 40ms

# Set bold pink prompt
Hide
Type `export PS1="$(printf '\e[1;38;2;197;37;143m> \e[0m')"`
Enter
Sleep 500ms
Type "clear"
Enter
Sleep 500ms
Show

# Step 1: Default table output
Sleep 500ms
Type "ipctl get automations"
Enter
Sleep 3s

# Step 2: JSON output
Type "ipctl get automations --output json"
Enter
Sleep 4s

# Step 3: YAML output
Type "ipctl get automations --output yaml"
Enter
Sleep 4s
38 changes: 38 additions & 0 deletions assets/gifs/tapes/ipctl-version.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Generated by gif-create
Output assets/gifs/ipctl-version.gif

# Terminal
Set Shell "bash"
Set Width 800
Set Height 500
Set FontSize 14
Set FontFamily "MonoLisa, Menlo, monospace"
Set LineHeight 1.4
Set LetterSpacing 0
Set Padding 20

# Brand (Itential)
Set Theme {"name":"Itential","black":"#101625","red":"#FF6633","green":"#99CA3C","yellow":"#FFAC73","blue":"#1B93D2","purple":"#C5258F","cyan":"#E5F2FE","white":"#FFFFFF","brightBlack":"#414042","brightRed":"#FF6633","brightGreen":"#99CA3C","brightYellow":"#FFAC73","brightBlue":"#1B93D2","brightPurple":"#C5258F","brightCyan":"#E5F2FE","brightWhite":"#FFFFFF","background":"#101625","foreground":"#FFFFFF","selectionBackground":"#1B93D2","cursor":"#FFFFFF","cursorAccent":"#101625"}
Set BorderRadius 8
Set MarginFill "#0D1018"
Set Margin 4
Set WindowBar "Colorful"

# Timing
Set TypingSpeed 50ms

# Set pink prompt, then clear screen
Hide
Type `export PS1="$(printf '\e[1;38;2;197;37;143m> \e[0m')"`
Enter
Sleep 500ms
Type "clear"
Enter
Sleep 500ms
Show

# Recording
Sleep 500ms
Type "ipctl version"
Enter
Sleep 2s
48 changes: 48 additions & 0 deletions assets/gifs/tapes/ipctl-workflow.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Generated by gif-create
Output assets/gifs/ipctl-workflow.gif

# Terminal
Set Shell "bash"
Set Width 900
Set Height 600
Set FontSize 14
Set FontFamily "MonoLisa, Menlo, monospace"
Set LineHeight 1.4
Set LetterSpacing 0
Set Padding 20

# Brand (Itential)
Set Theme {"name":"Itential","black":"#101625","red":"#FF6633","green":"#99CA3C","yellow":"#FFAC73","blue":"#1B93D2","purple":"#C5258F","cyan":"#E5F2FE","white":"#FFFFFF","brightBlack":"#414042","brightRed":"#FF6633","brightGreen":"#99CA3C","brightYellow":"#FFAC73","brightBlue":"#1B93D2","brightPurple":"#C5258F","brightCyan":"#E5F2FE","brightWhite":"#FFFFFF","background":"#101625","foreground":"#FFFFFF","selectionBackground":"#1B93D2","cursor":"#FFFFFF","cursorAccent":"#101625"}
Set BorderRadius 8
Set MarginFill "#0D1018"
Set Margin 4
Set WindowBar "Colorful"

# Timing
Set TypingSpeed 50ms

# Set bold pink prompt
Hide
Type `export PS1="$(printf '\e[1;38;2;197;37;143m> \e[0m')"`
Enter
Sleep 500ms
Type "clear"
Enter
Sleep 500ms
Show

# Step 1: List projects
Sleep 500ms
Type "ipctl get projects"
Enter
Sleep 3s

# Step 2: Describe a specific project
Type `ipctl describe project "Cisco IOS"`
Enter
Sleep 3s

# Step 3: List automations
Type "ipctl get automations"
Enter
Sleep 3s
1 change: 1 addition & 0 deletions assets/gifs/tapes/prompt.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export PS1=$'\e[38;2;197;37;143m> \e[0m'
3 changes: 3 additions & 0 deletions assets/gifs/tapes/vhs-shell.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/bash
export PS1=$'\e[38;2;197;37;143m> \e[0m'
exec bash --norc --noprofile -i
3 changes: 1 addition & 2 deletions docs/configuration-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,7 @@ configuration file based on the profile name.

The profile name can be passed to any command using the `--profile <name>`
command line argument. A default profile can also be set in the configuration
file. See `default_profile` in the [Application Settings}(#Application
Settings) section for a description.
file. See `default_profile` in the [Application Settings](#application-settings) section for a description.

## Configuration options

Expand Down