k9withabone/autocast

Automate terminal demos

autocast's Issues

Create GitHub workflow/action that automatically re-generates a asciinema file (and .gif)

Use case

The problem this tool solves is that cumbersome re-generating of custom asciinema CLI shows once your CLI tool changes etc. This solves a very annoying task. It automates this.

What if we take this paradigm even further?
Can't we create a GitHub workflow to automate it after each change (or tag if CLI output rarely changes and you want to save resources etc.?) For this project it would be a good try?
Going even further, what if why not just create a GitHub Action, so other's can use this, too?

Solution

The GitHub Action should:

• generate a new asciinema file
• optionally upload/update it on the asciinema website
• generate a gif out of it (or is there some Asciinema or other good GitHub Action or so for this already?)

With https://github.com/EndBug/add-and-commit/ the files could in your workflow then automatically be committed in the repository and a bot would automatically update your preview.

Problem: Do asciinema links need to be replaced? If so, ideally it should do this, too – though that would be cumbersome obviously? But if not, the better, then a link can stay stable.

Request: !Interactive - long strings

I don't know what the format of this would be, but I think the keys array could be improved by also allowing a string which would be treated a simple list of keys using the current typing speed, without any special parsing for waits or control codes.

This is would be easier to type and understand, and is a bit less verbose:

Maybe something like:

- !Interactive
  keys:
    - h
    - e
    - l
    - l
    - o
    - 2s
    - ^X
    - n

becomes

- !Interactive
  keys:
    - !Str hello
    - 2s
    - ^X
    - n

Loving autocast so far!

Demonstrating auto completion does not seem to be possible

I would like to use autocast to demonstrate my generic CLI script's auto
completion features.

As far as I understand this is currently not possible.
Control-I should send a tab character, so I tried to do it with this config.

- !Interactive
  command: 'cli '
  keys:
    - ^C
    - i
    - ^C
    - i

This does not work like I expected though. I think it is because it executes the
command before sending the key codes. It would be nice, if one could defer
execution with a flag, in which case the user would have to send a new line
character in the keys section to manually complete the command.
For example:

 !Interactive
 command: 'cli '
 defer_execution: true
 keys:
    - ^C
    - i
    - ^C
    - i
    - some_autocomletion_input
    - ^C
    - i
    - \n

Cheers!

Would this work with PowerSession-rs?

I haven't got a firm handle on how autocast gets the results it does, so perhaps this is a naive question, but would this tool possibly work with the repo https://github.com/Watfaq/PowerSession-rs which is an asciinema clone able to run on Windows?

---

Thanks a lot for this tool - I realised the need for something exactly like this when I started trying to set up a range of asciinema recordings recently for documentation I was sprucing up.

More built-in shell configurations

This is a tracking issue for adding more built-in shell configurations. For a shell to work with autocast, it must accept input on its stdin. The prompt should be changed to something unique so that autocast does not mistake something in a command's output as the prompt. See the bash defaults for an example. If you get a custom shell working, please comment with your configuration and I'll add it to autocast. Feel free to suggest other shells you would like to see built-in configurations for to be added to the list.

• zsh
• fish
• nu