qudosh

command module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2023 License: MIT Imports: 15 Imported by: 0

README

qudosh

qudosh is a tty proxy that records to ttyrec and uploads to S3. It runs a new process of the selected shell and proxies stdin and stdout.

Installation

You can download precopiled binary from releases or use go install

go install github.com/x-qdo/qudosh@latest

Usage

This will start a new process of the selected shell (by default, zsh) and proxy stdin and stdout. It will also record metrics every 10 seconds from stdin and stdout activity to a CSV file.

You can configure qudosh by setting the following environment variables:

  • QUDOSH_SHELL: The shell to be executed under the hood (defaults to zsh).
  • LOCAL_PREFIX: The location for recording files on the disk.
  • S3_BUCKET: The bucket name to upload to.
  • S3_PREFIX: The path inside the bucket.

License

qudosh is licensed under the MIT license. Please see the LICENSE file for more information.

Acknowledgments

qudosh was inspired by similar tools such as https://github.com/KubeOperator/webkubectl, and https://pkg.go.dev/maze.io/x/ttyrec. We thank the developers of these tools for their contributions to the open source community.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
packages
localcommand
Package localcommand provides an implementation of webtty.Slave that launches a local command with a PTY.
Package localcommand provides an implementation of webtty.Slave that launches a local command with a PTY.
tty
ttyrec
Package ttyrec implements TTY recording, compatible with ttyrec(1)
Package ttyrec implements TTY recording, compatible with ttyrec(1)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL