legneato/asciinema-rs

Asciinema client written in Rust

asciinema-rs's Issues

Support `asciinema rec --quiet`

See https://asciinema.org/docs/usage.

Sort of depends on #9.

Support `asciinema rec --yes`

See https://asciinema.org/docs/usage.

Depends on #5 to be useful.

Support `asciinema rec --stdin`

See https://asciinema.org/docs/usage.

The function that receives input from the terminal is already stubbed out here: https://github.com/LegNeato/asciinema-rs/blob/master/src/commands/record.rs#L82. You basically need to copy what output() below does, changing asciicast::EventType::Output to asciicast::EventType::Input. Don't forget add a test! An example test can be seen at https://github.com/LegNeato/asciinema-rs/blob/master/src/commands/record.rs#L255

Support `asciinema play` for asciicast page urls

See https://asciinema.org/docs/usage.

rec: OpenSSL error

:::akavel@k14:::~/dnload/asciinema/asciinema-v0.4.0-x86_64-unknown-linux-musl$ ./asciinema rec

⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇  🔴  [RECORDING]  ⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇⬇

akavel@k14:~/dnload/asciinema/asciinema-v0.4.0-x86_64-unknown-linux-musl$ echo hello world
hello world
akavel@k14:~/dnload/asciinema/asciinema-v0.4.0-x86_64-unknown-linux-musl$ exit
https://asciinema.org/api/asciicasts: The OpenSSL library reported an error: error:14090086:SSL routines:ssl3_get_server_certificate:certificate verify failed:s3_clnt.c:1269:
                                             :::akavel@k14:::~/dnload/asciinema/asciinema-v0.4.0-x86_64-unknown-linux-musl$

Not sure if this is a bug in the app or an issue with the OS (it's on a hosted machine, so I don't have control over versions of installed libs etc.)

By default capture `SHELL` and `TERM` environment variables

See https://asciinema.org/docs/usage and https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md.

Support `play` command

See https://asciinema.org/docs/usage. Play has a lot of functionality so it might be best to break it up into different tasks and PRs for each bit.

Switch to `AppSettings::InferSubcommands`

In #12 we added some aliases. It might be good to switch wholesale to AppSettings::InferSubcommands (https://docs.rs/clap/2.26.2/clap/enum.AppSettings.html).

Replace `asciinema.org` in all messages when `url` is set.

Users can set a different url in their config or as an env variable: https://asciinema.org/docs/config. We currently support this, but we don't change the hostname in messages to the user. If one is set, we should use the url's hostname rather than hardcoding asciinema.org.

Support `asciinema rec --command`

See https://asciinema.org/docs/usage.

This is likely more involved and requires changes to pty-shell. As it currently stands, running a single command causes stdout to die and the program to go in an infinite loop.

Support pausing`asciinema play` via the spacebar

See https://asciinema.org/docs/usage.

Support`asciinema play --idle-time-limit`

See https://asciinema.org/docs/usage.

Switch to portable_pty

We should use https://docs.rs/portable-pty/0.4.0/portable_pty/ as it is more modem and supported

Don't write to a temp file when local output file is specified

Currently we always write to a temp file and then copy the temp file at the end of the session. If we are passed a local file (asciinema rec /path/to/file), we should write to the file directly. This will make it so users can stream as mentioned in http://blog.asciinema.org/post/two-point-o/.

Switch off of `pty-shell`, possibly rewrite with futures and tokio

pty-shell is no longer maintained and uses mio directly. It would be nice to switch to tokio. As a bonus this will also likely enable us to ship to crates.io.

Support `asciinema play` for IPFS

See https://asciinema.org/docs/usage.

Set `ASCIINEMA_REC=1` in recorded TTY

From https://asciinema.org/docs/usage:

ASCIINEMA_REC=1 is added to recorded process environment variables. This can be used by your shell’s config file (.bashrc, .zshrc) to alter the prompt or play a sound when the shell is being recorded.

"Letterbox" terminal output when playing back smaller terminal recording

If we are playing back a recoding that was recoded in a smaller terminal, we should "letterbox" the output in the larger playback terminal so that the recording appears correct. We likely want to do something with curses to be fancy.

Support `cat` command

See https://asciinema.org/docs/usage.

Warn when playing back an asciicast session that was recorded in a larger terminal

We don't do any translation of the output data, so playing back in a smaller terminal may not work correctly depending on what happens in the recording session. We should warn in this case.

Video output support

We should support writing directly and converting to some movie format.

Support `asciinema play` for stdin

See https://asciinema.org/docs/usage.

Show progress bar while uploading

It would be neat to have a progress bar while uploading. It should respect the --quiet option.

Support `asciinema play` for local files

See https://asciinema.org/docs/usage.

Prompt for where to save after recording

After running asciinema rec, the reference python client prompts the user with the option to upload or save locally to a temp file. We currently do not prompt and instead always upload.

Support `asciinema play` for remote files

See https://asciinema.org/docs/usage.

SVG output support

We should support writing directly and converting to SVG.

Gif output support

I might be a good idea to build a new tool or sub-command which convert cast to gif(or svg). Original asciinema2gif is useful but installing deps is boring ：）
asciinema2gif: link

Make tests run in parallel

We turned off parallel tests (ec26f54), as tests for the configuration use env variables and interfere with each other. We should fix this.

Support exiting`asciinema play` via `CTRL+C`

See https://asciinema.org/docs/usage.

Support `asciinema rec --env`

See https://asciinema.org/docs/usage.

Add support for full word command aliases (e.g. `rec` -> `record`)

The official python program supports rec, play, cat, upload, and auth commands. For the two shortened ones (rec and auth) we should alias the full words as well to be friendlier (record and authenticate respectively).

Support stepping through`asciinema play` frames via `.`

See https://asciinema.org/docs/usage.

Update native-tls dep

error: failed to run custom build command for `openssl v0.9.24`
process didn't exit successfully: `/build/asciinema-rs/src/asciinema-rs-0.5.0/target/release/build/openssl-0afee69c03b43007/build-script-build` (exit code: 101)                                                                              
--- stderr
thread 'main' panicked at 'Unable to detect OpenSSL version', /build/.cargo/registry/src/github.com-1ecc6299db9ec823/openssl-0.9.24/build.rs:16:14

sfackler/rust-openssl#994 (comment)

Support `asciinema rec --raw`

See https://asciinema.org/docs/usage.

Support`asciinema play --speed`

See https://asciinema.org/docs/usage.

Support loading install id from `$HOME/.asciinema/install-id`

The docs at https://asciinema.org/docs/config suggest the location of the asciinema config based on some rules. It appears that the reference python binary ignores these for the install-id file and blindly writes it to $HOME/.asciinema/install-id (at least on macOS).

We should load from $HOME/.asciinema/install-id if it exists to reuse the install-id from the official client. If it doesn't exist, we should strive to be consistent and load from the directory specified in https://asciinema.org/docs/config.