tsh play --format=text

[zmb3]

For sessions with print events, this command will write the text directly to standard out. This makes it easier to grep for a particular pattern or just dump a session recording to a file for manual analysis.

Closes #11694

changelog: tsh play now supports a text output format

[github-actions]

The PR changelog entry failed validation: The changelog entry must start with a letter.

[github-actions]

The PR changelog entry failed validation: The changelog entry must start with a letter.

[GavinFrazar]

actually, I wonder if we should not strip ansi control characters? It messes up the output when I remote into my box that has fish shell (doing all kinds of colorful things and auto completions).

with stripping:

$ ~/code/timemachine/v16/build/tsh play f03e90e6-6e9a-489d-b92e-6ac8dc65dc95 --format text                                                                                                (dev) 
Welcome to fish, the friendly interactive shell
Type help for instructions on how to use fish
[13:28:36] gavin@pop-os ~  
c cd work/teleport
⏎                                                                                                                                                                                               [13:28:45] gavin@pop-os ~/work/teleport  
s ls
api              bpf                      buf-gogo.gen.yaml  buf.lock  build.assets    Cargo.toml          common.mk        darwin-signing.mk  doc.go  e2e           fixtures  gitref.go  go.work      integrations    LICENSE            metrics.go    proto        rfd          tool                version.go  webassets               webassets_noembed.go
assets           buf-connect-go.gen.yaml  buf-legacy.yaml    buf.yaml  BUILD_macos.md  CHANGELOG.md        constants.go     devbox.json        docs    e_imports.go  fuzz      go.mod     go.work.sum  jest.config.js  LICENSE-community  node_modules  protogen.go  SECURITY.md  tsconfig.json       version.mk  webassets_embed.go      yarn.lock
babel.config.js  buf-go.gen.yaml          buf-ts.gen.yaml    build     Cargo.lock      CODE_OF_CONDUCT.md  CONTRIBUTING.md  devbox.lock        e       examples      gen       go.sum     integration  lib             Makefile           package.json  README.md    target       tsconfig.node.json  web         webassets_embed_ent.go  
⏎                                                                                                                                                                                               [13:28:46] gavin@pop-os ~/work/teleport  
lsdocker ls
docker: 'ls' is not a docker command.
See 'docker --help'
⏎                                                                                                                                                                                               [13:28:49] gavin@pop-os ~/work/teleport [1] 
docker lsls
docker: 'ls' is not a docker command.
See 'docker --help'
⏎                                                                                                                                                                                               [13:28:53] gavin@pop-os ~/work/teleport [1] 
$ 

vs tsh built without the ansi stripping:

[I] [13:30:55] gavin@m3 ~/code/timemachine/v16  
$ ~/code/timemachine/v16/build/tsh play f03e90e6-6e9a-489d-b92e-6ac8dc65dc95 --format text                                                                                                (dev) 
Welcome to fish, the friendly interactive shell
Type help for instructions on how to use fish
[13:28:36] gavin@pop-os ~  
$ cd work/teleport
⏎                                                                                                                                                                                               [13:28:45] gavin@pop-os ~/work/teleport  
$ ls
api              bpf                      buf-gogo.gen.yaml  buf.lock  build.assets    Cargo.toml          common.mk        darwin-signing.mk  doc.go  e2e           fixtures  gitref.go  go.work      integrations    LICENSE            metrics.go    proto        rfd          tool                version.go  webassets               webassets_noembed.go
assets           buf-connect-go.gen.yaml  buf-legacy.yaml    buf.yaml  BUILD_macos.md  CHANGELOG.md        constants.go     devbox.json        docs    e_imports.go  fuzz      go.mod     go.work.sum  jest.config.js  LICENSE-community  node_modules  protogen.go  SECURITY.md  tsconfig.json       version.mk  webassets_embed.go      yarn.lock
babel.config.js  buf-go.gen.yaml          buf-ts.gen.yaml    build     Cargo.lock      CODE_OF_CONDUCT.md  CONTRIBUTING.md  devbox.lock        e       examples      gen       go.sum     integration  lib             Makefile           package.json  README.md    target       tsconfig.node.json  web         webassets_embed_ent.go  
⏎                                                                                                                                                                                               [13:28:46] gavin@pop-os ~/work/teleport  
$ docker ls
docker: 'ls' is not a docker command.
See 'docker --help'
⏎                                                                                                                                                                                               [13:28:49] gavin@pop-os ~/work/teleport [1] 
$ docker ls
docker: 'ls' is not a docker command.
See 'docker --help'
⏎                                                                                                                                                                                               [13:28:53] gavin@pop-os ~/work/teleport [1] 
$ 
[I] [13:30:59] gavin@m3 ~/code/timemachine/v16  
$                                                                                                                                                                                         (dev) 

[zmb3]

Decided to remove the ANSI stripping and just print the raw session. It's a bit simpler, requires no dependencies, and you can always pipe the output through to a separate tool that strips the ANSI control characters.

[public-teleport-github-review-bot]

@zmb3 See the table below for backport results.

Branch	Result
branch/v16	Create PR